@refinn/core-ui 0.1.3 → 0.1.5

package/README.md

@@ -1,3 +1,24 @@
+## Design tokens
+
+`src/preset/theme.css` is **generated** — do not edit it by hand.
+
+- Base/semantic colors, radius, and shadows come from `tokens/*.json` (Figma export via the
+  [lukasoppermann/design-tokens](https://github.com/lukasoppermann/design-tokens) plugin).
+- Component-specific tokens (Button, Checkbox, Toast, typography scale, …) live in
+  `src/preset/theme.components.css` and are hand-written — edit that file instead.
+
+Workflow when the design team ships a new export:
+
+1. Replace `tokens/core.tokens.json` and `tokens/design.tokens.json` with the new files.
+2. Run `npm run build:tokens` and review the diff in `src/preset/theme.css`.
+3. Run `npm run check:tokens` (also runs in CI) — it fails if theme.css is stale or if a
+   component still references a `var(--...)` that no longer exists.
+4. Commit and open a PR. A new color family or an existing group's new keys flow through
+   automatically (with a console warning); a brand-new component group requires a small edit
+   to `scripts/build-theme.mjs` (see `PENDING_GROUPS`, `NAME_OVERRIDES`, `VALUE_OVERRIDES`).
+
+---
+
 This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
 
 ## Getting Started