better-design 0.35.5 → 0.37.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -1
- package/dist/index.js +1752 -496
- package/dist/index.js.map +1 -1
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -23,6 +23,8 @@ Install links can record where you found Better Design with `npx better-design -
|
|
|
23
23
|
Supported source labels are `docs`, `github`, `claude_directory`, `openai_catalog`, `campaign`, and `unknown` (the default).
|
|
24
24
|
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.
|
|
25
25
|
|
|
26
|
+
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.
|
|
27
|
+
|
|
26
28
|
## Try it
|
|
27
29
|
|
|
28
30
|
Ask your agent:
|
|
@@ -73,6 +75,15 @@ expected and what came back. A person reads every report, and sending one
|
|
|
73
75
|
never spends credit. Known secret shapes are removed before the report is
|
|
74
76
|
stored.
|
|
75
77
|
|
|
78
|
+
## Keep a free key
|
|
79
|
+
|
|
80
|
+
A key the installer creates for you is free for a limited number of queries.
|
|
81
|
+
To keep it on a free account, open the claim link it gives you and sign in.
|
|
82
|
+
The page shows a line with a code; paste that line into your AI tool.
|
|
83
|
+
`confirm-claim` first names the account the key would join and asks you to
|
|
84
|
+
confirm it, then links the key and emails that account. Only the tool that
|
|
85
|
+
holds the key can confirm it, and the code works for ten minutes.
|
|
86
|
+
|
|
76
87
|
## Review UI code
|
|
77
88
|
|
|
78
89
|
Check changed JSX and TSX files in your project:
|
|
@@ -81,6 +92,10 @@ Check changed JSX and TSX files in your project:
|
|
|
81
92
|
npx better-design review
|
|
82
93
|
```
|
|
83
94
|
|
|
84
|
-
|
|
95
|
+
It reads your `components.json`, the stylesheet it names and your UI folder, so
|
|
96
|
+
a finding names your own theme colours and your components' variants. The
|
|
97
|
+
check for classes Tailwind does not generate builds your Tailwind theme, which
|
|
98
|
+
runs the plugins your stylesheet names, as your build does. The agent hook skips
|
|
99
|
+
that check. Run `npx better-design review --help` for options.
|
|
85
100
|
|
|
86
101
|
[Installation guide](https://better-design.com/mcp/install) · [Design systems](https://better-design.com/design-systems) · [Website](https://better-design.com)
|