better-design 0.24.0 → 0.31.0

package/README.md

@@ -2,7 +2,7 @@
 
 Give your coding agent design systems, UI and UX guidance, icons, and code reviews through MCP.
 
-Works with Codex, Claude Code, Cursor, VS Code, Windsurf, and other MCP clients.
+Works with Codex, Claude Code, Cursor, VS Code, Devin, Antigravity, and other MCP clients.
 
 ## Install
 
@@ -15,12 +15,56 @@ npx better-design
 
 The first installs the agent skill. The second connects Better Design to your coding tools. Restart your agent after setup.
 
+If you have no account, setup creates a free key for you. Using that key accepts the [Terms of Service](https://better-design.com/terms) at the version setup prints. Setup saves the key in `~/.better-design/key` and reuses it when you run it again on the same machine. To start over, delete that file.
+
+Your AI client loads Better Design at its next start. To get an answer in the session that ran setup, run `npx better-design ask "<question>"`, or add `--ux` for the UX principles.
+
+Install links can record where you found Better Design with `npx better-design --source docs`.
+Supported source labels are `docs`, `github`, `claude_directory`, `openai_catalog`, `campaign`, and `unknown` (the default).
+The installer sends this label when creating a free key and records npm as the install method. It does not infer your referral source or active client from the editors installed on your computer.
+
 ## Try it
 
 Ask your agent:
 
 > Use Better Design to build a settings page with my project's design system, then review it for accessibility and consistency.
 
+## Build a prototype from Figma
+
+With the Better Design plugin open in a Figma file, `create-figma-prototype`
+turns a frame into one HTML page built from that design system's components.
+Name a frame, or omit the name to take the current selection. The server
+starts a relay on `http://localhost:4397` that only the plugin talks to, so
+the file never leaves your machine. This tool is local only: the hosted
+connectors cannot reach your Figma.
+
+A frame from a file that was not built from a Better Design library has no
+components to map, so pass `mode: "model"` and a catalog `system`. The plugin
+asks you to confirm the frame. Your agent is the model: the tool writes a
+prompt file and the frame's image, your agent writes the page on its own
+plan, and a second call with `frameId` and `answerPath` checks the page and
+lists every layer that did not make it. No API key is needed. To use a local
+model instead, pass `provider: "openai-compatible"`: the tool calls Ollama at
+`http://localhost:11434/v1` with `gemma4:latest`, or the server in
+`BETTER_DESIGN_MODEL_BASE_URL`, with `BETTER_DESIGN_MODEL_API_KEY` if it needs
+one.
+
+## Map your product's features and flows
+
+Your agent keeps a map of the product in `.better-design/feature-map.json`:
+each feature, its flows, and the route, screen, components and data of every
+step. `build-feature-map` drafts it from `git ls-files`, `read-feature-map`
+names what a change to a flow touches, and `update-feature-map` adds, renames
+or removes a feature or flow in one call. The map stays in your repository;
+the tools store nothing.
+
+## Share your team's rules with every agent
+
+Paste your team's rules into
+[Team rules](https://better-design.com/dashboard/settings/team-rules), one
+Markdown document of up to 32 KB. `get-team-rules` gives them to any agent
+that uses your key, and `get-review-rules` checks the work against them.
+
 ## Review UI code
 
 Check changed JSX and TSX files in your project: