@hig/icon - npm Package Compare versions

Comparing version 0.1.0-alpha.0fd98f29 to 0.1.0-alpha.220175f3

package.json

 {
   "name": "@hig/icon",
-  "version": "0.1.0-alpha.0fd98f29",
+  "version": "0.1.0-alpha.220175f3",
   "description": "HIG Icon component",
@@ -8,2 +8,5 @@ "author": "Autodesk Inc.",
   "homepage": "https://hig.autodesk.com",
+  "publishConfig": {
+    "access": "public"
+  },
   "main": "build/index.js",
@@ -16,7 +19,7 @@ "module": "build/index.es.js",
   "dependencies": {
-    "@hig/icons": "0.1.0-alpha.0fd98f29"
+    "@hig/icons": "0.1.0-alpha.220175f3"
   },
   "devDependencies": {
-    "@hig/scripts": "0.2.0-alpha.0fd98f29",
-    "@hig/styles": "0.1.0-alpha.0fd98f29"
+    "@hig/scripts": "0.2.0-alpha.220175f3",
+    "@hig/styles": "0.1.0-alpha.220175f3"
   },
@@ -23,0 +26,0 @@ "peerDependencies": {

README.md

@@ -7,2 +7,15 @@ # Icon
 
+## Getting started
+
+```
+yarn add @hig/icon
+```
+
+## Import the component and CSS
+
+```
+import Icon from '@hig/icon';
+import '@hig/icon/build/index.css';
+```
+
 ## Typical usage
@@ -13,8 +26,3 @@
 ```jsx
-import Icon from '@hig/icon`;
-import '@hig/icon/build/index.css';
-
-function MyComponent() {
-  return <Icon name="assets" />
-}
+<Icon name="assets" />
 ```
@@ -25,8 +33,3 @@
 ```jsx
-import Icon from '@hig/icon`;
-import '@hig/icon/build/index.css';
-
-function MyComponent() {
-  return <Icon name="assets" size="16" />
-}
+<Icon name="assets" size="16" />
 ```
@@ -37,4 +40,2 @@
 ```jsx
-import Icon from '@hig/icon`;
-import '@hig/icon/build/index.css';
 import myIcon from 'my-icon.svg';
@@ -45,2 +46,2 @@
 }
-```
+```

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

43

increased by4.88%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

13948

decreased by-0.47%

Dependency changes

• + Added@hig/icons@0.1.0-alpha.220175f3(transitive)

• - Removed@hig/icons@0.1.0-alpha.0fd98f29(transitive)

• Updated@hig/icons@0.1.0-alpha.220175f3