@crossdelta/platform-sdk 0.3.15 → 0.3.17

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 +18 -17
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -57,10 +57,21 @@
57
57
  ### 1. Create a new workspace
58
58
 
59
59
  ```bash
60
- npx @crossdelta/platform-sdk new workspace my-platform
60
+ # Using npx (npm)
61
+ npx @crossdelta/platform-sdk@latest new workspace my-platform
62
+
63
+ # Using bunx (Bun - faster!)
64
+ bunx @crossdelta/platform-sdk@latest new workspace my-platform
65
+ ```
66
+
67
+ Or install globally and use the shorter `pf` command:
68
+
69
+ ```bash
70
+ npm install -g @crossdelta/platform-sdk
71
+ pf new workspace my-platform
61
72
  ```
62
73
 
63
- Or with options:
74
+ **With options:**
64
75
 
65
76
  ```bash
66
77
  pf new workspace my-platform -y # Skip prompts
@@ -77,8 +88,10 @@ pf new workspace my-platform --no-github # Without CI/CD
77
88
  | `-s, --pulumi-stack <name>` | Pulumi stack base name (org/project) |
78
89
  | `--no-github` | Skip GitHub Actions workflows |
79
90
 
80
- > 💡 `pf` is the CLI binary shipped with this package.
81
- > It automatically works through `npx` — no global install required.
91
+ > 💡 **Three ways to use the CLI:**
92
+ > - `npx @crossdelta/platform-sdk` — Run directly with npm (no install)
93
+ > - `bunx @crossdelta/platform-sdk` — Run with Bun (fastest, recommended)
94
+ > - `pf` — After global install, use the short alias
82
95
 
83
96
  ---
84
97
 
@@ -238,19 +251,7 @@ pulumi up --stack dev
238
251
 
239
252
  ---
240
253
 
241
- ## 📦 Installation
242
-
243
- ```bash
244
- # Via npx (recommended)
245
- npx @crossdelta/platform-sdk new workspace my-platform
246
-
247
- # Global install
248
- bun add -g @crossdelta/platform-sdk
249
- ```
250
-
251
- ---
252
-
253
- ## 👍 When to use this
254
+ ## When to use this
254
255
 
255
256
  - ✅ **Bun-first microservice platform** with minimal boilerplate
256
257
  - ✅ **Turborepo + Pulumi** as architectural baseline
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@crossdelta/platform-sdk",
3
- "version": "0.3.15",
3
+ "version": "0.3.17",
4
4
  "description": "CLI toolkit for scaffolding Turborepo workspaces with Pulumi infrastructure and Hono/NestJS microservices",
5
5
  "keywords": [
6
6
  "cli",
@@ -17,9 +17,9 @@
17
17
  ],
18
18
  "homepage": "https://www.npmjs.com/package/@crossdelta/platform-sdk",
19
19
  "bin": {
20
- "crossdelta-platform-sdk": "./bin/cli.js",
20
+ "pf": "./bin/cli.js",
21
21
  "platform": "./bin/cli.js",
22
- "pf": "./bin/cli.js"
22
+ "crossdelta-platform-sdk": "./bin/cli.js"
23
23
  },
24
24
  "engines": {
25
25
  "node": ">=21.0.0"