Skip to content

Commit 44c545a

Browse files
giacoelhoclaude
andcommitted
Point README's install instructions at GitHub until this is on the npm registry
npm install @rubyforgood/design-system currently 404s -- nobody's published it yet, and doing so needs an interactive npm login this session can't perform. Verified npm install github:rubyforgood/designsystem works right now and delivers tokens/theme.css exactly as documented, so that's the install path until a real npm publish happens. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
1 parent 9be4b96 commit 44c545a

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,20 @@ WCAG 2.2 conformance specifically.
3636

3737
## Using the tokens
3838

39+
Not on the npm registry yet (see Status below), but installable right now straight from GitHub:
40+
3941
```bash
40-
npm install @rubyforgood/design-system
42+
npm install github:rubyforgood/designsystem
4143
```
4244

4345
```css
4446
/* your Tailwind entry point */
4547
@import "@rubyforgood/design-system/tokens/theme.css";
4648
```
4749

50+
Once this is published to the registry, `npm install @rubyforgood/design-system` will work the
51+
same way and this page will be updated to lead with that instead.
52+
4853
That gives you the shipped default palette (indigo, Figtree, a 4px scale). Retheme by overriding
4954
the same token names; see [`tokens/README.md`](tokens/README.md) for which parts are load-bearing
5055
rules and which are just this default's answer.
@@ -77,7 +82,8 @@ has real, measured portability evidence for 22 of ~40 scripts (see
7782
documented, not-yet-attempted plans for the rest. `.github/workflows/checks.yml` runs syntax
7883
checks, a doc-link audit, and a regression check against the reference app on every push.
7984

80-
This has not been published to the npm registry yet.
85+
This has not been published to the npm registry yet — install straight from GitHub in the meantime
86+
(see "Using the tokens" above).
8187

8288
## History
8389

0 commit comments

Comments
 (0)