@pautena/react-design-system 0.4.0 → 0.4.2

package/LICENCE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Call-Em-All
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,10 +2,44 @@
 
 **WORK IN PROGRESS**
 
-![WIP](https://external-content.duckduckgo.com/iu/?u=https%3A%2F%2Ftse2.mm.bing.net%2Fth%3Fid%3DOIP.V0ck8qwYE6GRienn9nKiFAAAAA%26pid%3DApi&f=1)
+<img src="src/stories/assets/work-in-progress.jpg" width="200" height="180"/>
 
 My custom design system on top of [MUI](https://mui.com/material-ui/), with a bunch of components to be able to fast prototype new pages and products
 
-## Storybook
+## Installation
 
-Use Storybook to navigate and interact with the available components. Available [here](https://pautena.com/react-design-system)
+This project is available as an [npm package](https://www.npmjs.com/package/@pautena/react-design-system).
+
+npm:
+
+```bash
+npm install @pautena/react-design-system @emotion/react @emotion/styled @mui/icons-material @mui/lab @mui/material @mui/x-data-grid react-dom react-router-dom
+```
+
+yarn:
+
+```bash
+npm install @pautena/react-design-system @emotion/react @emotion/styled @mui/icons-material @mui/lab @mui/material @mui/x-data-grid react-dom react-router-dom
+```
+
+Now you are going to be able to import the components and use it in your React project.
+
+```javascript
+import { AppBarWithDrawerLayout } from "@pautena/react-design-system";
+```
+
+## Documentation
+
+If you want to know more about the components and the layouts availables in this project check our [documentation](https://pautena.com/react-design-system)
+
+## Contributing
+
+Read the [contribution guide](/CONTRIBUTING.md) to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes.
+
+## Issues and features
+
+If you found a bug or you have an idea for a new component, feel free to [open an issue](https://github.com/pautena/react-design-system/issues/new) explaining the bug or the new component that you would like to have.
+
+## Licence
+
+This project is licensed under the terms of the [MIT license](/LICENSE).