Commit 53bd1b4
docs: split README for npm consumers and move dev commands to CONTRIBUTING.md
The README ships with the npm tarball and becomes the package landing page
on npmjs.com. Keeping developer-only commands (storybook, build, typecheck,
lint, lint:staged) there was misleading since consumers install from npm,
receive only dist/, and cannot run any of those scripts.
- README.md: consumer-only (install, peer deps, usage, flavor list, link to
CONTRIBUTING). This is what the npmjs.com page and GitHub home render.
- CONTRIBUTING.md: repo setup, dev commands, release flow (local
npm publish), project structure. Not included in the tarball
(files: ["dist"]) so it stays a GitHub-only contributor doc.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent fafebf1 commit 53bd1b4
2 files changed
Lines changed: 46 additions & 15 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
65 | 65 | | |
66 | 66 | | |
67 | 67 | | |
68 | | - | |
| 68 | + | |
69 | 69 | | |
70 | | - | |
71 | | - | |
72 | | - | |
73 | | - | |
74 | | - | |
75 | | - | |
76 | | - | |
77 | | - | |
78 | | - | |
79 | | - | |
80 | | - | |
81 | | - | |
82 | | - | |
83 | | - | |
| 70 | + | |
84 | 71 | | |
85 | 72 | | |
86 | 73 | | |
| |||
0 commit comments