diff --git a/README.md b/README.md index e4a4c55..5ab96fb 100644 --- a/README.md +++ b/README.md @@ -8,4 +8,32 @@ ## Install ```bash -yarn add @impact-market/ui \ No newline at end of file +yarn add @impact-market/ui +``` + +## Develop + +1. Clone it +```bash +git clone git@github.com:impactMarket/ui.git +``` + +2. Install [nvm](https://github.com/nvm-sh/nvm) then run it and install the correct version if needed +```bash +nvm use +``` + +3. Install project +```bash +yarn install +``` + +4. Develop +```bash +yarn storybook +``` + + +## TODO +- Write project aspects +- Write development notes \ No newline at end of file