@trimble-oss/modus-react-components - npm Package Compare versions

Comparing version 0.1.42-17 to 0.1.43-17

package.json

 {
   "name": "@trimble-oss/modus-react-components",
-  "version": "0.1.42-17",
+  "version": "0.1.43-17",
   "description": "Trimble Modus React Component Library",
@@ -36,3 +36,3 @@ "homepage": "https://modus-web-components.trimble.com/",
   "dependencies": {
-    "@trimble-oss/modus-web-components": "0.1.42"
+    "@trimble-oss/modus-web-components": "0.1.43"
   },
@@ -39,0 +39,0 @@ "devDependencies": {

README.md

@@ -1,13 +0,22 @@
-# React Workspace
+# Modus React Components
 
-This project was generated for React [v17.0.2](https://github.com/facebook/react/blob/main/CHANGELOG.md#1702-march-22-2021).
+## About
 
-This React Project is a utility wrapper to help build the `@trimble-oss/modus-react-components` library.
+This is a React wrapper library for [Modus Web Components](https://www.npmjs.com/package/@trimble-oss/modus-web-components) and the components were programmatically generated using the [Stencil](https://stenciljs.com/) for React [v17.0.2](https://github.com/facebook/react/blob/main/CHANGELOG.md#1702-march-22-2021).
 
-All components in this repository are auto generated by the [Stencil](https://stenciljs.com/docs/introduction) library.
+## Installation
 
-To build a local copy of these components you can run:
+Install the Modus React Components Library and its Modus Web Component dependency
+`npm install @trimble-oss/modus-react-components --save`
 
-`npm run build`
+## Example Usage
 
-This can be consumed in a local react application using `npm link`
+- Use a Modus Button in your `App.tsx`
+
+  ```html
+  <ModusButton color="primary">Primary Button</ModusButton>
+  ```
+
+## Contributing
+
+To contribute to the Modus React Components library please see the Modus Web Components [contributing guidelines](https://github.com/trimble-oss/modus-web-components/blob/main/CONTRIBUTING.md) and how to generate [Modus React components](https://github.com/trimble-oss/modus-web-components/blob/main/CONTRIBUTING.md#react).

No alert changes

Improved metrics

Total package byte prevSize

37771

increased by1.27%

Number of lines in readme file

23

increased by64.29%

Dependency changes

• + Added@stencil/core@3.4.2(transitive)

• + Added@trimble-oss/modus-web-components@0.1.43(transitive)

• - Removed@stencil/core@2.22.3(transitive)

• - Removed@trimble-oss/modus-web-components@0.1.42(transitive)

• Updated@trimble-oss/modus-web-components@0.1.43