@crossdelta/platform-sdk 0.3.23 → 0.3.24

package/README.md

@@ -158,21 +158,42 @@ my-platform/
 
 ## ⚡ Event-Driven Architecture
 
-Built on **CloudEvents** and **NATS JetStream** using **[`@crossdelta/cloudevents`](https://github.com/orderboss/platform/tree/main/packages/cloudevents)**:
+Every workspace includes **NATS + JetStream** for event-driven microservices communication using **[`@crossdelta/cloudevents`](https://github.com/orderboss/platform/tree/main/packages/cloudevents)**:
 
 - 🎯 **Type-safe event handlers** with Zod schemas
 - 🔄 **Auto-discovery** of event handlers (`*.event.ts` files)
 - 📦 **Publisher/Consumer patterns** out of the box
-- 🚀 **Production-ready** NATS JetStream integration
+- 🚀 **NATS auto-scaffolded** in `services/nats/` with Docker setup
+- 🗄️ **JetStream persistence** for durable event streaming
+
+### NATS Message Broker
+
+Every workspace includes a pre-configured NATS service:
+
+```bash
+# Auto-started with `bun dev`
+services/nats/
+├── nats.conf              # Local dev config (JetStream enabled)
+├── nats.prod.conf         # Production config (auth + persistence)
+├── scripts/start-dev.sh   # Docker startup script
+└── README.md              # Full NATS documentation
+```
+
+**Local Development:**
+- Runs in Docker on ports `4222` (client) and `8222` (HTTP monitoring)
+- Data persisted in `.nats-data/` directory
+- Health check: `curl http://localhost:8222/healthz`
+
+### Publish Events
 
-**Publish events:**
 ```typescript
 import { publish } from '@crossdelta/cloudevents'
 
 await publish('orders.created', { orderId: 'ord_123', total: 99.99 })
 ```
 
-**Consume events (auto-discovered):**
+### Consume Events (Auto-Discovered)
+
 ```typescript
 // services/notifications/src/handlers/order-created.event.ts
 import { handleEvent } from '@crossdelta/cloudevents'
@@ -189,6 +210,8 @@ export default handleEvent(OrderCreatedSchema, async (data) => {
 })
 ```
 
+**📚 Learn more:** See `services/nats/README.md` in your workspace for monitoring, configuration, and JetStream details.
+
 <br />
 
 ---