@crossdelta/platform-sdk 0.21.7 → 0.21.9

package/README.md

@@ -9,13 +9,10 @@
 </p>
 
 <p align="center">
-  <code>pf</code> scaffolds real-world platforms: backend services, event-driven messaging, infrastructure — all wired together and kept in sync. <strong>AI-assisted.</strong>
+  <code>pf</code> scaffolds real-world platforms: backend services, event-driven messaging, infrastructure. All wired together and kept in sync. <strong>AI-assisted.</strong>
 </p>
 
-<p align="center">
-  <sub>Frontend SDK coming soon — contract-based client models.</sub>
 
-</p>
 
 <br />
 
@@ -29,55 +26,15 @@
   <img src="https://img.shields.io/badge/License-MIT-22c55e?style=for-the-badge" alt="MIT License" />
 </p>
 
-<p align="center">
-  <img src="https://img.shields.io/badge/Hono-E36002?style=flat-square&logo=hono&logoColor=white" alt="Hono" />
-  <img src="https://img.shields.io/badge/NestJS-E0234E?style=flat-square&logo=nestjs&logoColor=white" alt="NestJS" />
-  <img src="https://img.shields.io/badge/NATS-27AAE1?style=flat-square&logo=natsdotio&logoColor=white" alt="NATS" />
-  <img src="https://img.shields.io/badge/Pulumi-8A3391?style=flat-square&logo=pulumi&logoColor=white" alt="Pulumi" />
-  <img src="https://img.shields.io/badge/Turborepo-EF4444?style=flat-square&logo=turborepo&logoColor=white" alt="Turborepo" />
-  <img src="https://img.shields.io/badge/DigitalOcean-0080FF?style=flat-square&logo=digitalocean&logoColor=white" alt="DigitalOcean" />
-</p>
-
-<br />
-
 <p align="center">
   <a href="#-quick-start">Quick Start</a> •
   <a href="#-5-minute-tutorial">Tutorial</a> •
   <a href="#-commands">Commands</a> •
-  <a href="#-ai-assisted-generation">AI Generation</a> •
   <a href="#-deployment">Deployment</a>
 </p>
 
 ---
 
-<br />
-
-## 👋 Who is this for?
-
-<table>
-<tr>
-<td width="60">🏗️</td>
-<td><strong>Teams building full-stack platforms</strong> — services, events, apps that actually work together</td>
-</tr>
-<tr>
-<td>📡</td>
-<td><strong>Event-driven architectures</strong> — or teams ready to start using events</td>
-</tr>
-<tr>
-<td>😤</td>
-<td><strong>Engineers tired of drift</strong> — ports, env vars, and infra configs that never match</td>
-</tr>
-<tr>
-<td>🚀</td>
-<td><strong>Startups & platform teams</strong> — who want consistency without building everything from scratch</td>
-</tr>
-</table>
-
-> **You can start without understanding all the pieces.**
-> The depth reveals itself as you grow.
-
----
-
 ## 🚀 Quick Start
 
 ```bash
@@ -137,7 +94,7 @@ pf cloudevents add order.created --service services/notifications
 # 3. Restart to pick up new services
 pf dev
 
-# 4. Publish a test event — watch notifications react
+# 4. Publish a test event, watch notifications react
 pf cloudevents publish order.created
 ```
 
@@ -159,34 +116,7 @@ pf cloudevents publish order.created
 
 ---
 
-## 💡 What problem does pf solve?
-
-<table>
-<tr>
-<th width="300">❌ The Problem</th>
-<th width="300">✅ With pf</th>
-</tr>
-<tr>
-<td>Application code lives here, infra config lives somewhere else</td>
-<td>Both generated from the same source of truth</td>
-</tr>
-<tr>
-<td>Ports, env vars, and event wiring drift over time</td>
-<td>Change a service → infra stays in sync</td>
-</tr>
-<tr>
-<td>New devs spend days setting up local environments</td>
-<td>Run <code>pf dev</code> → everything starts together</td>
-</tr>
-<tr>
-<td>Manual event subscriptions and handler registration</td>
-<td>Add an event → consumers are wired automatically</td>
-</tr>
-</table>
-
----
-
-## 📋 Commands
+##  Commands
 
 | Command | What it does |
 |:--------|:-------------|
@@ -203,48 +133,7 @@ pf cloudevents publish order.created
 | `pf lint` | ✨ Lint and format with Biome |
 | `pf audit` | 🔒 Run security audit on dependencies |
 
-> `pf` proxies all commands to Turborepo (works from any subdirectory).
-
-#### Custom Command Descriptions
-
-Add descriptions to your workspace commands for better autocompletion:
-
-```json
-{
-  "pf": {
-    "commands": {
-      "deploy": {
-        "command": "cd infra && pulumi up",
-        "description": "Deploy infrastructure to production"
-      }
-    }
-  }
-}
-```
-
-Then `pf <TAB>` shows: `deploy -- Deploy infrastructure to production`
-
-#### Plugins
-
-Extend `pf` with additional commands via plugins. Plugins are loaded from workspace `package.json`:
-
-```json
-{
-  "pf": {
-    "plugins": ["@crossdelta/cloudevents"]
-  }
-}
-```
-
-**Built-in plugins:**
-- `@crossdelta/cloudevents` - Event contracts, handlers, and NATS publishing (auto-enabled in new workspaces)
-
-**Plugin commands are namespaced:**
-```bash
-pf cloudevents add order.created --service services/orders
-pf cloudevents list
-pf cloudevents publish order.created
-```
+> `pf` proxies all commands to Turborepo (works from any subdirectory). Extend via [custom commands and plugins](https://www.npmjs.com/package/@crossdelta/platform-sdk#configuration).
 
 ---
 
@@ -259,7 +148,7 @@ pf new hono-micro services/notifications --ai \
   -d "Send emails when orders are created"
 ```
 
-The AI generates **production-ready code** that follows your platform's conventions:
+The AI generates **convention-following code** tailored to your platform:
 
 <table>
 <tr>
@@ -280,30 +169,34 @@ The AI generates **production-ready code** that follows your platform's conventi
 </tr>
 <tr>
 <td>✅</td>
-<td><strong>Type-safe</strong> — no <code>any</code>, proper imports, strict TypeScript</td>
+<td><strong>Type-safe:</strong> no <code>any</code>, proper imports, strict TypeScript</td>
 </tr>
 <tr>
 <td>✅</td>
-<td><strong>Lint-compliant</strong> — passes Biome formatting out of the box</td>
+<td><strong>Lint-compliant:</strong> passes Biome formatting out of the box</td>
 </tr>
 </table>
 
 **What makes it different:**
 - Uses your **existing contracts** when wiring events between services
 - Follows **framework-specific patterns** (Hono use-cases vs. NestJS Services)
-- Generates **only the code you need** — no bloat, no unused abstractions
-- **Hot-reload friendly** — `pf dev` automatically restarts when AI finishes
+- Generates **only the code you need**, no bloat, no unused abstractions
+- **Hot-reload friendly:** `pf dev` automatically restarts when AI finishes
 
-Works with OpenAI (GPT-4o) and Anthropic (Claude 3.5 Sonnet).
+Works with OpenAI and Anthropic.
 
 ---
 
 ## 🚢 Deployment
 
 ```bash
-pf pulumi up --stack dev
+pf pulumi up              # deploys the current Pulumi stack
 ```
 
+Each workspace ships with one Pulumi stack and pre-configured GitHub Actions. Add more stacks (e.g. `stage`, `production`) as your platform grows. `pf` and `generate-env` work with any stack name.
+
+`pf dev` generates `.env.local` from the current stack's Pulumi config (secrets, API keys) and discovered service ports.
+
 **Pre-configured GitHub Actions included:**
 
 | Trigger | Action |
@@ -321,13 +214,12 @@ pf pulumi up --stack dev
 |:-------|:------------|
 | `PULUMI_ACCESS_TOKEN` | [Pulumi Cloud token](https://app.pulumi.com/account/tokens) |
 | `DIGITALOCEAN_TOKEN` | [DO API token](https://cloud.digitalocean.com/account/api/tokens) |
-| `GHCR_TOKEN` | GitHub Container Registry PAT |
 
 </details>
 
 ---
 
-## 📋 Requirements
+## ⚙️ Requirements
 
 | Requirement | Notes |
 |:------------|:------|
@@ -495,43 +387,12 @@ Every workspace includes pre-configured NATS with JetStream for development:
 - Streams materialized from contracts with retention policies
 - Persistent storage (file-based) with explicit limits
 
-> **Services never create streams** — in dev: `pf dev` auto-creates from contracts, in prod: Pulumi materializes.
-
-See `infra/dev/README.md` for Dev-Infra vs Platform-Infra separation.
+> **Services never create streams.** In dev, `pf dev` auto-creates from contracts. In prod, Pulumi materializes.
 
 </details>
 
 ---
 
-## 🧭 Philosophy
-
-<table>
-<tr>
-<td width="50%">
-
-### ✅ What pf is
-
-- Opinionated full-stack platform toolkit
-- Unified dev workflow — one command to run everything
-- Infrastructure that stays in sync with your code
-
-</td>
-<td width="50%">
-
-### ❌ What pf is not
-
-- Generic scaffolder — it makes choices for you
-- Multi-cloud out of the box — DigitalOcean first, extensible later
-- Magic — no hidden daemons, you control when things run
-
-</td>
-</tr>
-</table>
-
-> **`pf` makes architectural decisions so your team doesn't have to — without hiding how things work.**
-
----
-
 ## License
 
 MIT © [crossdelta](https://crossdelta.de)