diff --git a/README.md b/README.md index 45f6e9010..d395a54e0 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,16 @@ $ yarn start ## Styleguide -All reusable Components (for example avatar) should be done inside the styleguide directory. +All reusable Components (for example avatar) should be done inside the [Nitro-Styleguide](https://github.com/Human-Connection/Nitro-Styleguide) repository. ![Styleguide Screenshot](screenshot-styleguide.png) More information can be found here: https://github.com/Human-Connection/Nitro-Styleguide +If you need to change something in the styleguide and want to see the effects on the frontend immediately, then we have you covered. +You need to clone the styleguide to the parent directory `../Nitro-Styleguide` and run `yarn && yarn run dev`. After that you run `yarn run dev:styleguide` instead of `yarn run dev` and you will see your changes reflected inside the fronten! + ## Internationalization (i18n) You can help translating the interface by joining us on [lokalise.co](https://lokalise.co/public/556252725c18dd752dd546.13222042/).