Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aidanCQ authored Oct 23, 2024
1 parent 20f81b1 commit fb12d23
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
# quantinuum-ui
Quantinuum design tokens and React components.

Based on [shadcn](https://ui.shadcn.com/), an opinionated tailwind theme and radix-ui component generator. Shadcn isn't a direct dependency but has a CLI tool to generate components into this repo based on `components.json`.
Based on [shadcn](https://ui.shadcn.com/), an opinionated tailwind theme and radix-ui component generator. Shadcn components have been generated into this repo using the `components.json` definition and re-exported as a new library.

### Development

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


### Design Tokens
CSS variables are declared in `src/tokens.css`. Dark mode is enabled when using the attribute `data-theme="dark"` higher up in the DOM tree. See `src/tokens.css` for more details.
Expand Down

0 comments on commit fb12d23

Please sign in to comment.