Skip to content

Commit

Permalink
chore: Update getting started docs (#1451)
Browse files Browse the repository at this point in the history
  • Loading branch information
alimpens authored Jul 24, 2024
1 parent e3b117e commit 9d51b99
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,4 +222,4 @@ Contact the maintainers if you want to release a new version of a package.

## :pray: Credits

This document is adapted from a template made by [@jessesquires](https://github.com/jessesquires).
This document is adapted from [a template made by jessesquires](https://github.com/jessesquires/.github).
11 changes: 5 additions & 6 deletions storybook/src/docs/developer-guide/getting-started.docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,7 @@ import { Meta } from "@storybook/blocks";
Install the packages you need, for instance:

```bash
npm install
@amsterdam/design-system-assets
@amsterdam/design-system-css
@amsterdam/design-system-react
@amsterdam/design-system-react-icons
@amsterdam/design-system-tokens
npm install @amsterdam/design-system-assets @amsterdam/design-system-css @amsterdam/design-system-react @amsterdam/design-system-react-icons @amsterdam/design-system-tokens
```

Import the components and stylesheets you need, for example:
Expand Down Expand Up @@ -45,3 +40,7 @@ To use the compact mode, import the compact CSS **after** the theme CSS, like so
import "@amsterdam/design-system-tokens/dist/index.css";
import "@amsterdam/design-system-tokens/dist/compact.css";
```

## Contributing

Do you want to contribute to this project? Please review [our Contributing guidelines](https://github.com/Amsterdam/design-system/blob/develop/CONTRIBUTING.md).

0 comments on commit 9d51b99

Please sign in to comment.