@crossdelta/platform-sdk 0.3.17 → 0.3.19

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 (3) hide show
  1. package/README.md +7 -15
  2. package/bin/cli.js +164 -164
  3. package/package.json +2 -4
package/README.md CHANGED
@@ -57,22 +57,15 @@
57
57
  ### 1. Create a new workspace
58
58
 
59
59
  ```bash
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
60
+ # Install globally (recommended)
70
61
  npm install -g @crossdelta/platform-sdk
71
62
  pf new workspace my-platform
63
+
64
+ # Or use bunx (no install needed)
65
+ bunx @crossdelta/platform-sdk pf new workspace my-platform
72
66
  ```
73
67
 
74
68
  **With options:**
75
-
76
69
  ```bash
77
70
  pf new workspace my-platform -y # Skip prompts
78
71
  pf new workspace my-platform -o my-github-org # Set GitHub owner
@@ -88,10 +81,9 @@ pf new workspace my-platform --no-github # Without CI/CD
88
81
  | `-s, --pulumi-stack <name>` | Pulumi stack base name (org/project) |
89
82
  | `--no-github` | Skip GitHub Actions workflows |
90
83
 
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
84
+ > 💡 **Two ways to use the CLI:**
85
+ > - **Global install** (recommended): `npm install -g @crossdelta/platform-sdk` use `pf` command
86
+ > - **Bunx** (no install): `bunx @crossdelta/platform-sdk pf <command>`
95
87
 
96
88
  ---
97
89