Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
aidanCQ committed Dec 18, 2023
1 parent 5e34a15 commit b08ed52
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,18 @@ Quantinuum design tokens and React components.

Based on [shadcn](https://ui.shadcn.com/), an opinionated tailwind / radix-ui theme. Shadcn isn't a direct dependency but has a CLI tool to generate components into this repo based on `components.json`.

Run storybook
### Development

```bash
npm run dev
```
npm run dev # Run storybook application to view components.
npm run build-storybook # Build storybook application as static HTML.
npm run build-lib # Build component library with rollup
```

### Design Tokens
CSS variables declared in `src/tokens.css`. Dark mode is toggled by the presence of the class `.data-theme-dark` somewhere higher in the DOM tree.

Run jest unit tests
```
npm run test
```

Build library with rollup
```bash
npm run build
```



Expand Down

0 comments on commit b08ed52

Please sign in to comment.