better-design 0.36.0 → 0.38.0

package/README.md

@@ -23,6 +23,8 @@ Install links can record where you found Better Design with `npx better-design -
 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.
 
+Rerunning setup preserves existing connections. If setup reports a manual step, finish it first. Then ask your agent to list Better Design's design systems and confirm that a tool returns a result.
+
 ## Try it
 
 Ask your agent:
@@ -60,10 +62,38 @@ 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.
+Your team's rules are one Markdown document of up to 32 KB. `get-team-rules`
+gives them to any agent that uses your key, `get-review-rules` checks the work
+against them, and `check-comprehension` fails copy that uses a word they ban.
+
+When you have no rules yet, `get-team-rules` hands your agent an outline. The
+agent drafts the rules with you from your project and your live site, and
+`set-team-rules` saves them once you approve the draft. You can also paste them
+into [Team rules](https://better-design.com/dashboard/settings/team-rules).
+
+When you correct a choice your agent made, and the correction should hold for
+every build, `propose-team-rule` turns it into one proposed rule. It waits on
+the Team rules page, and no agent follows it until you approve it there.
+
+A client project keeps its own rules beside its design system: one guidelines
+document, a use, never or pairing rule for each part or value, a ban for the
+whole brand, and specs on a screen or on one part of it. Pass `projectId` to
+`set-team-rules` to save one piece. Pass `projectId`, `screen` and `parts` to
+`get-team-rules`, and the agent gets only what that screen needs.
+
+To reach agents that never call these tools, a local model included, run this
+at the root of your repository:
+
+```bash
+npx better-design rules
+```
+
+It writes your team rules, the components your review settings name, and the
+AI-feature rules in short into `AGENTS.md`, and into `CLAUDE.md` when the
+repository keeps one. Every agent reads that file before each task. The
+command shows your team rules and asks before it writes them; in a script, add
+`--yes` once a person has read them. Commit the file, and run the command again
+when the rules change.
 
 ## Report a bug or a missing feature
 
@@ -77,8 +107,9 @@ stored.
 
 A key the installer creates for you is free for a limited number of queries.
 To keep it on a free account, open the claim link it gives you and sign in.
-The page shows a line with a code; paste that line into your AI tool, and
-`confirm-claim` links the key it holds to your account. Only the tool that
+The page shows a line with a code; paste that line into your AI tool.
+`confirm-claim` first names the account the key would join and asks you to
+confirm it, then links the key and emails that account. Only the tool that
 holds the key can confirm it, and the code works for ten minutes.
 
 ## Review UI code