From bb599d4679435154e8a50e3e892feb7fc724fc06 Mon Sep 17 00:00:00 2001
From: Michael Zetterberg <michael.zetterberg@scandichotels.com>
Date: Wed, 12 Mar 2025 15:34:01 +0100
Subject: [PATCH] fix: update readme for design system

---
 packages/design-system/README.md | 57 +++++++++++++++++++++++++-------
 1 file changed, 45 insertions(+), 12 deletions(-)

diff --git a/packages/design-system/README.md b/packages/design-system/README.md
index 8f2230b10..11cb36166 100644
--- a/packages/design-system/README.md
+++ b/packages/design-system/README.md
@@ -36,27 +36,60 @@ One such notable component is the `Typography` component. Read the documentation
 To get started with the project, clone the repository and install the dependencies:
 
 ```bash
-git clone git@bitbucket.org:scandic-swap/design-system.git
-cd design-system
-npm install
+git clone git@bitbucket.org:scandic-swap/web.git
+cd web
+yarn
+```
+
+### Do your changes
+
+Work your magic.
+
+### Build the project
+
+```bash
+yarn workspace @scandic-hotels/design-system build
+```
+
+### Push the build output to origin
+
+```bash
+git add packages/design-system/
+git commit
+git push
 ```
 
 ## Main script targets
 
+Run the following script targets either from the project root with:
+
+```bash
+yarn workspace @scandic-hotels/design-system <script target>
+```
+
+Or run them from the package directory:
+
+```bash
+cd packages/design-system
+yarn <script target>
+```
+
+Both approaches give the same result.
+
 ### Develop
 
-| Command             | Action                                                                                                                         |
-| ------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
-| `npm run dev`       | Runs the example project through Vite in dev mode. This command will start a local development server that serves `./example`. |
-| `npm run storybook` | Starts the Storybook server and launches into the Storybook UI.                                                                |
-| `npm run lint`      | Lints the codebase using ESLint and TypeScript.                                                                                |
-| `npm run lint:fix`  | Automatically fixes linting issues wherever possible.                                                                          |
+| Script target | Action                                                                                                                         |
+| ------------- | ------------------------------------------------------------------------------------------------------------------------------ |
+| `dev`         | Runs the example project through Vite in dev mode. This command will start a local development server that serves `./example`. |
+| `storybook`   | Starts the Storybook server and launches into the Storybook UI.                                                                |
+| `lint`        | Lints the codebase using ESLint and TypeScript.                                                                                |
+| `lint:fix`    | Automatically fixes linting issues wherever possible.                                                                          |
 
 ### Build
 
-| Command         | Action                                               |
-| --------------- | ---------------------------------------------------- |
-| `npm run build` | Builds the design system distribution into `./dist`. |
+| Script target | Action                                               |
+| ------------- | ---------------------------------------------------- |
+| `build`       | Builds the design system distribution into `./dist`. |
 
 ## Project Structure