@coderabbitai/carrot-ui 0.1.20 → 0.1.21

package/README.md

@@ -71,6 +71,16 @@ function App() {
 }
 ```
 
+## Documentation
+
+Run `pnpm dev` and visit `/reference` for the full component playground. Foundations:
+
+- **Colors** (`/reference/foundations/colors`) — OKLCH scales and semantic tokens
+- **Spacing** (`/reference/foundations/spacing`) — spacing scale
+- **Principles** (`/reference/foundations/principles`) — the cross-cutting design and API conventions every component follows. Source: [`principles.mdx`](./src/reference/pages/foundations/principles.mdx) — readable directly on GitHub.
+
+If you're authoring a new component, start with **Principles** — it's the source of truth for the visual and API conventions.
+
 ## Development
 
 ```bash
@@ -83,4 +93,14 @@ pnpm lint         # linting
 
 ## Publishing
 
-Publishing runs when a `v*` tag is pushed. The workflow publishes to GitHub Packages and the public npm registry, then creates a GitHub release with the packed tarball.
+Release Please opens release PRs from changes on `main`. Use conventional commit prefixes such as `fix:` and `feat:` so Release Please can choose the next version. Merge the Release Please PR to bump `package.json`, update `CHANGELOG.md`, create the `v*` tag, and publish the package.
+
+The publish workflow checks that the `v*` tag matches `package.json`, publishes to GitHub Packages and the public npm registry, then uploads the packed tarball to the GitHub release. Manual `v*` tags still work, but the tag version must match `package.json`.
+
+Required GitHub Actions secrets:
+
+- `CODERABBIT_NPM_TOKEN`: npm publish token for the public npm registry.
+- `GITHUB_TOKEN`: built-in GitHub Actions token used for GitHub Packages, release PRs, tags, and release assets.
+- `RELEASE_PLEASE_TOKEN`: optional GitHub token for Release Please. Use this if Release Please PRs need normal CI checks to run.
+
+Configure repository secrets in GitHub under Settings → Secrets and variables → Actions.