@department-of-veterans-affairs/mobile-assets - npm Package Compare versions

Comparing version 0.1.1 to 0.2.0

package.json

 {
   "name": "@department-of-veterans-affairs/mobile-assets",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "VA Design System Mobile Assets",
@@ -5,0 +5,0 @@ "repository": {

README.md

@@ -1,4 +0,16 @@
-# VA Mobile Design Library Assets
-This repository contains static assets such as fonts and SVG icons for use by VA mobile applications. It does not contain any code, so it is up to the consumer to import these assets into their app.
+# VA Mobile Design System - Assets Package
 
-The [components package](https://github.com/department-of-veterans-affairs/va-mobile-library) contains an Icon convenience component that makes leveraging both the assets package icons and custom ones easy. See code for the [Icon component](https://github.com/department-of-veterans-affairs/va-mobile-library/blob/main/packages/components/src/components/Icon/Icon.tsx). Additional documentation can be found in the [Design System section](https://department-of-veterans-affairs.github.io/va-mobile-app/design/Intro) of VA Mobile docs.
+The Assets package contains static assets such as fonts and SVG icons for use by VA mobile applications. 
+
+## For consumers
+
+The Assets package is a peer dependency to the Components package so it is expected to be added separately via your package manager (e.g. yarn) alongside using components. It does not contain any code, so it is up to the consumer to configure the package to be leveraged by their app, [notably the fonts so they are available within your app](https://blog.logrocket.com/adding-custom-fonts-react-native/) for the components.
+
+The [components package](https://github.com/department-of-veterans-affairs/va-mobile-library/tree/main/packages/components) contains [an Icon convenience component](https://github.com/department-of-veterans-affairs/va-mobile-library/blob/main/packages/components/src/components/Icon/Icon.tsx) that makes leveraging both the assets package icons and custom SVGs specific to your app easy; it is highly recommended to use for icon needs.
+
+## For contributors
+Not much to say for contributors as this is just a collection of assets.
+
+Before contributing, consider if the contribution is necessary. This package is intended for shared assets. If your asset is only relevant to a specific app, then it should be handled within the app. Keep in mind the Icon convenience component can handle custom SVGs to help display an app-level icon without it being part of the assets package.
+
+As there is no code and nothing to be run, contributing is as simple as adding the asset [to the package via the GitHub web interface](https://github.com/department-of-veterans-affairs/va-mobile-library/tree/main/packages/assets) using the add file/folder buttons and creating a PR. 

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 1 instance in 1 package

Improved metrics

Number of downloads

1955

increased by38.85%

Number of lines in readme file

16

increased by220%

Number of medium supply chain risk alerts

4

decreased by-20%

Worsened metrics

Total package byte prevSize

2020196

decreased by-0.7%

Number of package files

62

decreased by-6.06%

No dependency changes