@steez-ui/icons 0.1.0 → 0.1.2

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.
Files changed (2) hide show
  1. package/README.md +82 -25
  2. package/package.json +3 -2
package/README.md CHANGED
@@ -1,52 +1,109 @@
1
1
  # Steez UI
2
2
 
3
- Shared Phantasy UI primitives and shadcn-compatible registry output.
3
+ Standalone React primitives, flat theme tokens, and shadcn-compatible registry output.
4
4
 
5
- Registry frontend: `https://steez-ui.pages.dev`
5
+ ## Overview
6
+
7
+ Steez UI is authored once and shipped in two forms:
8
+
9
+ - npm packages for direct React consumption
10
+ - generated registry payloads for source-level installation
11
+
12
+ The source of truth lives in `packages/ui`. The registry output is generated from that same source tree, so the package build and registry install path stay aligned.
13
+
14
+ Live surfaces:
15
+
16
+ - Registry frontend: `https://steez-ui-6v5.pages.dev`
17
+ - Docs: `https://steez-ui-6v5.pages.dev/docs/`
18
+ - Packages: `https://steez-ui-6v5.pages.dev/packages/`
19
+ - Registry page: `https://steez-ui-6v5.pages.dev/registry/`
20
+ - Registry index: `https://steez-ui-6v5.pages.dev/r/index.json`
21
+ - Foundation preset: `https://steez-ui-6v5.pages.dev/r/foundation.json`
6
22
 
7
23
  ## Packages
8
24
 
9
25
  - `@steez-ui/theme`
26
+ Theme tokens and compatibility aliases.
10
27
  - `@steez-ui/icons`
28
+ Shared icon surface and provider.
11
29
  - `@steez-ui/ui`
30
+ React primitives authored in `.tsx` and `.module.css`.
12
31
 
13
- ## App
14
-
15
- - `@steez-ui/registry`
32
+ ## Install
16
33
 
17
- ## Scripts
34
+ Registry:
18
35
 
19
- - `bun run build`
20
- - `bun run check:release`
21
- - `bun run publish:packages:dry-run`
22
- - `bun run publish:packages`
23
- - `bun run deploy:registry`
24
- - `bun run generate:registry`
25
- - `bun run test`
26
- - `bun run test:install-smoke`
36
+ ```bash
37
+ bunx shadcn@latest add https://steez-ui-6v5.pages.dev/r/foundation.json
38
+ ```
27
39
 
28
- ## Install
40
+ Packages:
29
41
 
30
42
  ```bash
31
- bunx shadcn@latest add https://steez-ui.pages.dev/r/foundation.json
43
+ bun add @steez-ui/theme @steez-ui/icons @steez-ui/ui
32
44
  ```
33
45
 
46
+ ## Repo Layout
47
+
48
+ ```text
49
+ packages/
50
+ theme/ # tokens and compatibility exports
51
+ icons/ # icon primitives and provider
52
+ ui/ # canonical component source
53
+
54
+ apps/
55
+ registry/ # public install frontend and registry docs
56
+ ```
57
+
58
+ ## Authoring Model
59
+
60
+ - `packages/theme` defines tokens first.
61
+ - `packages/icons` owns the shared icon surface.
62
+ - `packages/ui` is the canonical primitive source.
63
+ - `scripts/generate-registry.mjs` emits the registry JSON payloads from package source.
64
+ - `apps/registry` is the documentation, preview, and install frontend.
65
+
66
+ ## Development
67
+
34
68
  ```bash
35
- bun add @steez-ui/theme @steez-ui/icons @steez-ui/ui
69
+ bun install
70
+ bun run build
71
+ bun run test
72
+ bun run test:install-smoke
36
73
  ```
37
74
 
75
+ Useful commands:
76
+
77
+ - `bun run generate:registry`
78
+ - `bun run check:release`
79
+ - `bun run publish:packages:dry-run`
80
+ - `bun run publish:packages`
81
+ - `bun run deploy:registry`
82
+
83
+ ## Adding Or Updating A Primitive
84
+
85
+ 1. Build or update the component in `packages/ui/src/components`.
86
+ 2. Export it from `packages/ui/src/index.ts`.
87
+ 3. Add or update the registry item definition in `scripts/generate-registry.mjs`.
88
+ 4. Run `bun run build` and `bun run test`.
89
+ 5. Confirm the registry frontend reflects the new component or install path.
90
+
38
91
  ## Release Flow
39
92
 
40
- 1. `bun install`
41
- 2. `bun run check:release`
42
- 3. `bun run publish:packages`
43
- 4. `bun run deploy:registry`
93
+ 1. `bun run check:release`
94
+ 2. `bun run publish:packages`
95
+ 3. `bun run deploy:registry`
96
+
97
+ GitHub Actions mirror the same CI, npm publish, and Cloudflare Pages deploy path.
98
+
99
+ ## Current Packages
44
100
 
45
- GitHub Actions mirror the same path for CI, npm publish, and Cloudflare Pages deployment.
101
+ - `@steez-ui/theme@0.1.2`
102
+ - `@steez-ui/icons@0.1.2`
103
+ - `@steez-ui/ui@0.1.2`
46
104
 
47
- ## One-Time External Setup
105
+ ## External Setup
48
106
 
49
- - Create or claim the npm scope `@steez-ui`, then grant the publishing account access.
50
107
  - Add `NPM_TOKEN` to the GitHub repository secrets before using the package publish workflow.
51
108
  - Add `CLOUDFLARE_API_TOKEN` and `CLOUDFLARE_ACCOUNT_ID` to the GitHub repository secrets before relying on the Pages deploy workflow.
52
- - Until those secrets exist, the GitHub publish and deploy workflows will skip with a notice instead of failing.
109
+ - Keep the Cloudflare Pages project named `steez-ui` so the deploy script and workflow stay in sync.
package/package.json CHANGED
@@ -1,6 +1,7 @@
1
1
  {
2
2
  "name": "@steez-ui/icons",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
+ "description": "Shared icon exports and icon provider for Steez UI.",
4
5
  "license": "MIT",
5
6
  "type": "module",
6
7
  "files": [
@@ -22,7 +23,7 @@
22
23
  "type": "git",
23
24
  "url": "git+https://github.com/thomasjvu/steez-ui.git"
24
25
  },
25
- "homepage": "https://steez-ui.pages.dev",
26
+ "homepage": "https://steez-ui-6v5.pages.dev",
26
27
  "bugs": {
27
28
  "url": "https://github.com/thomasjvu/steez-ui/issues"
28
29
  }