@hig/icon-button - npm Package Compare versions

Comparing version 0.1.0-alpha.434672b9 to 0.1.0-alpha.62b0f70b

package.json

 {
   "name": "@hig/icon-button",
-  "version": "0.1.0-alpha.434672b9",
+  "version": "0.1.0-alpha.62b0f70b",
   "description": "HIG IconButton component",
@@ -15,7 +15,7 @@ "author": "Autodesk Inc.",
   "dependencies": {
-    "@hig/icon": "0.1.0-alpha.434672b9"
+    "@hig/icon": "0.1.0-alpha.62b0f70b"
   },
   "devDependencies": {
-    "@hig/scripts": "0.2.0-alpha.434672b9",
-    "@hig/styles": "0.1.0-alpha.434672b9"
+    "@hig/scripts": "0.2.0-alpha.62b0f70b",
+    "@hig/styles": "0.1.0-alpha.62b0f70b"
   },
@@ -22,0 +22,0 @@ "peerDependencies": {

README.md

@@ -7,2 +7,15 @@ # IconButton
 
+## Getting started
+
+```
+yarn add @hig/icon-button
+```
+
+## Import the component and CSS
+
+```
+import IconButton from '@hig/icon-button';
+import '@hig/icon-button/build/index.css;
+```
+
 ## Typical usage
@@ -13,5 +26,2 @@
 ```jsx
-import Icon from '@hig/icon-button`;
-import '@hig/icon-button/build/index.css';
-
 function MyComponent() {
@@ -30,4 +40,2 @@ return (
 ```jsx
-import Icon from '@hig/icon-button`;
-import '@hig/icon-button/build/index.css';
 import myIcon from 'my-icon.svg';
@@ -43,2 +51,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

Improved metrics

Total package byte prevSize

30460

increased by0.07%

Number of lines in readme file

49

increased by22.5%

Dependency changes

• + Added@hig/icon@0.1.0-alpha.62b0f70b(transitive)

• + Added@hig/icons@0.1.0-alpha.62b0f70b(transitive)

• - Removed@hig/icon@0.1.0-alpha.434672b9(transitive)

• - Removed@hig/icons@0.1.0-alpha.434672b9(transitive)

• Updated@hig/icon@0.1.0-alpha.62b0f70b