@volvo-cars/ced-os-react-components - npm Package Compare versions

Comparing version 0.1.6 to 0.1.7

package.json

 {
   "name": "@volvo-cars/ced-os-react-components",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "Set of components for developing UIs in the onboarding and support apps",
@@ -5,0 +5,0 @@ "keywords": [],

README.md

@@ -8,5 +8,6 @@ # Onboarding and Support Components
 
-# Development 
-## Getting Started
+## Development 
 
+### Getting Started
+
 - `npm install`
@@ -17,10 +18,19 @@ - `npm run dev` to run storybook
 
-# Publish
+### Publish
 
-The library is automatically published to Github packages when a new tag in the format `v.X.X.X` is pushed to Github. Use `npm version patsh|minor|major` to bump version an
+The library is automatically published to Github packages and NPM when a new tag in the format `v.X.X.X` is pushed to Github. Use `npm version patsh|minor|major` to bump version an
 
-# Install library in a project
+## Usage
 
-The library is published as an NPM Github package. To be able to install it in your project some configuration and Github authentication is needed.
+The library is published as an NPM package and also a Github package.
 
+### Install from NPM package registry
+
+Run `npm install @volvo-cars/ced-os-react-components`.
+
+
+### Install from Github package registry 
+
+To be able to install the package from the Github registry some configuration and Github authentication is needed.
+
 Add a file called `.npmrc` to your project and paste the lines below into it to configure NPM to load @volvo-cars packages from the Github registry. The second line 
@@ -42,1 +52,15 @@ references an environment variable on your machine: `VCC_GITHUB_PACKAGES_TOKEN`.
 
+### Example usage
+
+```
+// ...
+import { JSONArticle } from '@volvo-cars/ced-os-react-components';
+
+const Article = ({ articleId, content }) => {
+    return (
+        <View paddingTop={[3, 6]} paddingBottom={[3, 6]}>
+            <JSONArticle data-article-id={articleId} data={content} />
+        </View>
+);
+};
+```

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

84709

increased by0.57%

Number of lines in readme file

64

increased by60%

No dependency changes