Skip to content

Commit

Permalink
Update README (komodorio#250)
Browse files Browse the repository at this point in the history
* Update README

Componenet library section

* Update dashboard/README.md

---------

Co-authored-by: chad11111 <[email protected]>
  • Loading branch information
2 people authored and aman1376 committed Mar 24, 2023
1 parent e715c20 commit 4f7eaae
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion dashboard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,14 @@ Inorder to open a pull request with your changes. \
for example) and get your pull request reviewed.

# Component library
TODO
We created a components library to have a consistent design system throughout the project. Please rely on these components.
Additional information and examples on how to use them are available when you run Storybook, which shows them in an interactive way and in different scenarios.

Once you run it, you'll be able to see pre-made scenarios, documentation, and play with the component properties.

To run Storybook, make sure that all the dependencies are installed and run:
```shell
npm run storybook
```

Refer to the [official documentation](https://storybook.js.org/docs/react/get-started/install) for more information.

0 comments on commit 4f7eaae

Please sign in to comment.