From b08ed52129b8e867a33c26f876ed51c90234936c Mon Sep 17 00:00:00 2001 From: aidanCQ Date: Mon, 18 Dec 2023 09:38:51 +0000 Subject: [PATCH] Update readme. --- README.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 8033d03..9745e5c 100644 --- a/README.md +++ b/README.md @@ -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 -```