shru-design-system 0.6.0 → 0.6.1
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 +62 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# shru-design-system
|
|
2
|
+
|
|
3
|
+
React component library — **98 components**, multi-axis token themes, Tailwind + CVA.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm install shru-design-system
|
|
7
|
+
npx shru-design-system-init
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
Published: `dist/` components, `styles.css`, Tailwind preset.
|
|
11
|
+
|
|
12
|
+
**Prop-level API:** TypeScript `XxxProps` · local dev: `npm run dev` → `/gallery`
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Documentation
|
|
17
|
+
|
|
18
|
+
| Audience | Start here |
|
|
19
|
+
|----------|------------|
|
|
20
|
+
| **Consumer** — install & use in your app | [docs/use/INSTALL.md](./docs/use/INSTALL.md) |
|
|
21
|
+
| **Contributor** — change this repo | [docs/build/CONTRIBUTING.md](./docs/build/CONTRIBUTING.md) |
|
|
22
|
+
| **Architecture** — system structure | [docs/reference/ARCHITECTURE.md](./docs/reference/ARCHITECTURE.md) |
|
|
23
|
+
|
|
24
|
+
### Consumers — `docs/use/`
|
|
25
|
+
|
|
26
|
+
| Doc | Covers |
|
|
27
|
+
|-----|--------|
|
|
28
|
+
| [Install](./docs/use/INSTALL.md) | Peers, init, styles, Tailwind, first component |
|
|
29
|
+
| [Theming](./docs/use/THEMING.md) | Presets, `useTheme`, `applyPreset`, ThemeToggle |
|
|
30
|
+
| [Recipes](./docs/use/RECIPES.md) | App shell, TreeView, forms, modals |
|
|
31
|
+
| [Features](./docs/use/FEATURES.md) | Overlays, toasts, forms, input API contracts |
|
|
32
|
+
|
|
33
|
+
### Contributors — `docs/build/`
|
|
34
|
+
|
|
35
|
+
| Doc | Covers |
|
|
36
|
+
|-----|--------|
|
|
37
|
+
| [Contributing](./docs/build/CONTRIBUTING.md) | Layout, conventions, tokens, checks |
|
|
38
|
+
| [Components](./docs/build/COMPONENTS.md) | Add / update component checklist |
|
|
39
|
+
| [Gallery](./docs/build/GALLERY.md) | Metadata pipeline, wrappers |
|
|
40
|
+
| [Release](./docs/build/RELEASE.md) | `npm run check`, build, publish |
|
|
41
|
+
|
|
42
|
+
### Architecture — `docs/reference/`
|
|
43
|
+
|
|
44
|
+
| Doc | Covers |
|
|
45
|
+
|-----|--------|
|
|
46
|
+
| [Architecture](./docs/reference/ARCHITECTURE.md) | Repo map, build pipeline, check gates |
|
|
47
|
+
| [Components](./docs/reference/COMPONENTS.md) | 98 shipped spec |
|
|
48
|
+
| [Component graph](./docs/reference/COMPONENT_GRAPH.md) | Composition flowcharts |
|
|
49
|
+
| [Tokens](./docs/reference/TOKENS.md) | Token JSON layout, pipeline |
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Local preview
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
npm run dev
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
| Route | Purpose |
|
|
60
|
+
|-------|---------|
|
|
61
|
+
| `/gallery` | Component catalog + props panel |
|
|
62
|
+
| `/showcase` | Mini admin app (composed patterns) |
|