chore: add readme (#9)

* chore: add readme

Co-authored-by: Sed Ali <sajjadi@inside.sahab.ir>

README.md

@@ -1,90 +1,48 @@
-# Sahab Design System
+<h1 align="center">Sahab Design System</h1>
 
-This project was generated using [Nx](https://nx.dev).
+Sahab Design System provides React UI components based on [MUI](https://mui.com). Click [HERE](https://main--62d39f56a426a9878a3e1f3d.chromatic.com) to see the storybooks.
 
-<p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="450"></p>
+## 📦 Install
 
-🔎 **Smart, Fast and Extensible Build System**
+```bash
+npm install @my-sahab/design-system
+```
 
-## Adding capabilities to your workspace
+```bash
+yarn add @my-sahab/design-system
+```
 
-Nx supports many plugins which add capabilities for developing different types of applications and different tools.
+## 🔨 Usage
 
-These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.
+```jsx
+import { createTheme, ThemeProvider, Button } from '@my-sahab/design-system';
 
-Below are our core plugins:
+const theme = createTheme();
 
-- [React](https://reactjs.org)
-  - `npm install --save-dev @nrwl/react`
-- Web (no framework frontends)
-  - `npm install --save-dev @nrwl/web`
-- [Angular](https://angular.io)
-  - `npm install --save-dev @nrwl/angular`
-- [Nest](https://nestjs.com)
-  - `npm install --save-dev @nrwl/nest`
-- [Express](https://expressjs.com)
-  - `npm install --save-dev @nrwl/express`
-- [Node](https://nodejs.org)
-  - `npm install --save-dev @nrwl/node`
+const App = () => (
+  <ThemeProvider theme={theme}>
+    <Button type="primary">PRESS ME</Button>
+  </ThemeProvider>
+);
+```
 
-There are also many [community plugins](https://nx.dev/community) you could add.
+## ⌨️ Development
 
-## Generate an application
+This repo is powered by [Nx](https://nx.dev). You can use Nx commands to work with this repo. We recommend using [Nx vscode extention](https://nx.dev/using-nx/console#nx-console-for-vscode) for better experience.
 
-Run `nx g @nrwl/react:app my-app` to generate an application.
+To run all storybooks locally:
 
-> You can use any of the plugins above to generate applications as well.
+```bash
+$ git clone git@github.com:sahabpardaz/design-system.git
+$ cd desing-system
+$ yarn install
+$ yarn storybook
+```
 
-When using Nx, you can create multiple applications and libraries in the same workspace.
+You can also use chromatic for UI review. [link](https://www.chromatic.com/builds?appId=62d39f56a426a9878a3e1f3d)
 
-## Generate a library
+## 🤝 Contributing [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 
-Run `nx g @nrwl/react:lib my-lib` to generate a library.
+We welcome contributions to Sahab design system! Development of design system happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements.
 
-> You can also use any of the plugins above to generate libraries as well.
-
-Libraries are shareable across libraries and applications. They can be imported from `@reactjs-tools/mylib`.
-
-## Development server
-
-Run `nx serve my-app` for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
-
-## Code scaffolding
-
-Run `nx g @nrwl/react:component my-component --project=my-app` to generate a new component.
-
-## Build
-
-Run `nx build my-app` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
-
-## Running unit tests
-
-Run `nx test my-app` to execute the unit tests via [Jest](https://jestjs.io).
-
-Run `nx affected:test` to execute the unit tests affected by a change.
-
-## Running end-to-end tests
-
-Run `nx e2e my-app` to execute the end-to-end tests via [Cypress](https://www.cypress.io).
-
-Run `nx affected:e2e` to execute the end-to-end tests affected by a change.
-
-## Understand your workspace
-
-Run `nx graph` to see a diagram of the dependencies of your projects.
-
-## Further help
-
-Visit the [Nx Documentation](https://nx.dev) to learn more.
-
-## ☁ Nx Cloud
-
-### Distributed Computation Caching & Distributed Task Execution
-
-<p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-cloud-card.png"></p>
-
-Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly.
-
-Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers.
-
-Visit [Nx Cloud](https://nx.app/) to learn more.
+📥 [Pull requests](https://github.com/sahabpardaz/design-system/pulls) and 🌟 Stars are always welcome.