@clay-design-system/registry 0.0.0-stage → 0.14.0

package/README.md

@@ -1,3 +1,27 @@
-# Temporary Holding Version
+# @clay-design-system/registry
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The Clay Registry: monday.com's marketing design system (components, sections, tokens, assets, rules) as one queryable
+SQLite database, with a query layer that has no runtime dependencies. Read-only; internal units are not included.
+
+Requires **Node >= 22.13** (uses the built-in `node:sqlite`, no flag needed).
+
+## Install
+
+```sh
+pnpm add @clay-design-system/registry
+```
+
+## Use
+
+```js
+import { search, get, assetUrl } from '@clay-design-system/registry'
+
+search('hero section')                          // ranked hits: [{ id, kind, name, summary, links, score }, …]
+get('section.FeaturesSection')                  // one compact record (import path, story, Figma and CDN links)
+get('section.FeaturesSection', { detail: true }) // every column, plus links, relations and renders
+assetUrl('asset.icon.calendar')                 // https://… CDN URL
+```
+
+Also exported: `list`, `related`, `assetVariants`, `componentsUsingToken`, `allowedChildren`, `pageRecipe`, `openRegistry`,
+the `Registry` class, the response types, and `DB_PATH` / `RECORDS_PATH` (absolute paths to the shipped
+`data/clay.sqlite` and `data/records.json`, built when the package is built; gitignored in the repo).