@steez-ui/icons 0.1.0 → 0.1.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.
Files changed (2) hide show
  1. package/README.md +79 -25
  2. package/package.json +3 -2
package/README.md CHANGED
@@ -1,52 +1,106 @@
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
+ - Registry index: `https://steez-ui-6v5.pages.dev/r/index.json`
18
+ - Foundation preset: `https://steez-ui-6v5.pages.dev/r/foundation.json`
6
19
 
7
20
  ## Packages
8
21
 
9
22
  - `@steez-ui/theme`
23
+ Theme tokens and compatibility aliases.
10
24
  - `@steez-ui/icons`
25
+ Shared icon surface and provider.
11
26
  - `@steez-ui/ui`
27
+ React primitives authored in `.tsx` and `.module.css`.
12
28
 
13
- ## App
14
-
15
- - `@steez-ui/registry`
29
+ ## Install
16
30
 
17
- ## Scripts
31
+ Registry:
18
32
 
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`
33
+ ```bash
34
+ bunx shadcn@latest add https://steez-ui-6v5.pages.dev/r/foundation.json
35
+ ```
27
36
 
28
- ## Install
37
+ Packages:
29
38
 
30
39
  ```bash
31
- bunx shadcn@latest add https://steez-ui.pages.dev/r/foundation.json
40
+ bun add @steez-ui/theme @steez-ui/icons @steez-ui/ui
32
41
  ```
33
42
 
43
+ ## Repo Layout
44
+
45
+ ```text
46
+ packages/
47
+ theme/ # tokens and compatibility exports
48
+ icons/ # icon primitives and provider
49
+ ui/ # canonical component source
50
+
51
+ apps/
52
+ registry/ # public install frontend and registry docs
53
+ ```
54
+
55
+ ## Authoring Model
56
+
57
+ - `packages/theme` defines tokens first.
58
+ - `packages/icons` owns the shared icon surface.
59
+ - `packages/ui` is the canonical primitive source.
60
+ - `scripts/generate-registry.mjs` emits the registry JSON payloads from package source.
61
+ - `apps/registry` is the documentation, preview, and install frontend.
62
+
63
+ ## Development
64
+
34
65
  ```bash
35
- bun add @steez-ui/theme @steez-ui/icons @steez-ui/ui
66
+ bun install
67
+ bun run build
68
+ bun run test
69
+ bun run test:install-smoke
36
70
  ```
37
71
 
72
+ Useful commands:
73
+
74
+ - `bun run generate:registry`
75
+ - `bun run check:release`
76
+ - `bun run publish:packages:dry-run`
77
+ - `bun run publish:packages`
78
+ - `bun run deploy:registry`
79
+
80
+ ## Adding Or Updating A Primitive
81
+
82
+ 1. Build or update the component in `packages/ui/src/components`.
83
+ 2. Export it from `packages/ui/src/index.ts`.
84
+ 3. Add or update the registry item definition in `scripts/generate-registry.mjs`.
85
+ 4. Run `bun run build` and `bun run test`.
86
+ 5. Confirm the registry frontend reflects the new component or install path.
87
+
38
88
  ## Release Flow
39
89
 
40
- 1. `bun install`
41
- 2. `bun run check:release`
42
- 3. `bun run publish:packages`
43
- 4. `bun run deploy:registry`
90
+ 1. `bun run check:release`
91
+ 2. `bun run publish:packages`
92
+ 3. `bun run deploy:registry`
93
+
94
+ GitHub Actions mirror the same CI, npm publish, and Cloudflare Pages deploy path.
95
+
96
+ ## Current Packages
44
97
 
45
- GitHub Actions mirror the same path for CI, npm publish, and Cloudflare Pages deployment.
98
+ - `@steez-ui/theme@0.1.1`
99
+ - `@steez-ui/icons@0.1.1`
100
+ - `@steez-ui/ui@0.1.1`
46
101
 
47
- ## One-Time External Setup
102
+ ## External Setup
48
103
 
49
- - Create or claim the npm scope `@steez-ui`, then grant the publishing account access.
50
104
  - Add `NPM_TOKEN` to the GitHub repository secrets before using the package publish workflow.
51
105
  - 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.
106
+ - 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.1",
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
  }