@crossdelta/platform-sdk 0.4.1 → 0.4.3

package/README.md

@@ -40,14 +40,14 @@ Building microservice platforms is hard. You start with great intentions, but co
 - **Environment hell** — `.env` files manually maintained, ports collide, services don't talk
 - **Slow onboarding** — new developers spend days setting up the platform
 
-**`pf` acts like an opinionated platform engineer on your team.** It's a single CLI that:
+**`pf` is an opinionated CLI for platform engineering.** It helps you:
 
-- Scaffolds production-ready monorepos with best practices baked in
-- Generates microservices (manually or with AI) with consistent structure
-- Auto-wires infrastructure, environment variables, and port assignments
-- Unifies your dev workflow: one command to run everything locally
+- Scaffold monorepos with consistent structure and tooling
+- Generate microservices (manually or AI-assisted) with shared conventions
+- Auto-configure infrastructure, environment variables, and port assignments
+- Run all services locally with a single command
 
-Built for teams using **Turborepo + Pulumi + NATS + Bun** who want to move fast without sacrificing quality.
+Built for teams using **Turborepo + Pulumi + NATS + Bun**.
 
 <br />
 
@@ -59,16 +59,16 @@ Built for teams using **Turborepo + Pulumi + NATS + Bun** who want to move fast
 
 - **Opinionated CLI** for event-driven microservice platforms
 - **Turborepo scaffolder** with Pulumi IaC and NATS messaging built-in
-- **AI-powered code generator** that creates complete services from natural language
-- **Unified dev workflow** — one command to rule them all (`bun dev`)
+- **AI-assisted code generator** that creates service boilerplate from descriptions
+- **Unified dev workflow** — one command to run all services (`bun dev`)
 - **DigitalOcean-first** deployment target (App Platform + DOKS)
 
 ### ❌ `pf` is not:
 
-- **Not a generic microservice generator** — we make architectural choices for you
-- **Not cloud-agnostic** (yet) — DigitalOcean first, AWS/GCP coming later
-- **Not a runtime manager** — we scaffold code, you deploy with Pulumi
-- **Not a replacement for Kubernetes** — we generate K8s configs via Pulumi
+- **Generic microservice generator** — makes architectural choices for you
+- **Cloud-agnostic** (yet) — DigitalOcean first, AWS/GCP planned
+- **Runtime manager** — scaffolds code, you deploy with Pulumi
+- **Kubernetes replacement** — generates K8s configs via Pulumi
 
 <br />
 
@@ -233,12 +233,12 @@ You're building a new product from scratch and want to establish a solid foundat
 
 ```bash
 # Step 1: Scaffold the workspace
-bunx @crossdelta/platform-sdk new workspace orderboss-platform \
-  --github-owner orderboss \
+bunx @crossdelta/platform-sdk new workspace my-platform-platform \
+  --github-owner my-platform \
   --pulumi-stack dev \
   -y
 
-cd orderboss-platform
+cd my-platform-platform
 
 # Step 2: Configure infrastructure (optional)
 # Edit infra/config.ts to customize:
@@ -283,30 +283,32 @@ pf new hono-micro services/payments -y
 bun dev
 ```
 
-**Option B: AI-powered generation (intelligent, complete)**
+**Option B: AI-powered generation (intelligent scaffolding)**
 
 ```bash
 # First time: configure AI provider
 pf setup --ai
 
-# Generate a complete service with AI
+# Generate service boilerplate with AI
 pf new hono-micro services/payments --ai \
   -d "Stripe payment processing: handle checkout.session.completed webhooks, \
       publish payment.succeeded events, update order status in database"
 
 # AI generates:
-# ✅ Complete service implementation with Stripe SDK
-# ✅ Event handlers for incoming orders
-# ✅ Event publishers for payment lifecycle
-# ✅ Use cases with validation logic
-# ✅ Test files for all use cases
+# ✅ Service structure with Stripe SDK integration
+# ✅ Event handler stubs for incoming webhooks
+# ✅ Event publisher functions for payment lifecycle
+# ✅ Use case templates with validation logic
+# ✅ Test file boilerplate
 # ✅ Environment variable documentation
-# ✅ Complete README with API docs
+# ✅ Basic README with usage examples
 ```
 
 **When to use which:**
 - **Manual scaffolding:** You know exactly what you're building, want full control
-- **AI generation:** Bootstrapping new domains, exploring integrations, speeding up prototyping
+- **AI generation:** Quick prototyping, exploring new integrations, generating boilerplate faster
+
+**Note:** AI-generated code is a starting point, not production-ready. Always review and refine.
 
 ---