@crossdelta/platform-sdk 0.3.22 → 0.3.24

package/README.md

@@ -156,6 +156,66 @@ my-platform/
 
 ---
 
+## ⚡ Event-Driven Architecture
+
+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
+- 🚀 **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
+
+```typescript
+import { publish } from '@crossdelta/cloudevents'
+
+await publish('orders.created', { orderId: 'ord_123', total: 99.99 })
+```
+
+### Consume Events (Auto-Discovered)
+
+```typescript
+// services/notifications/src/handlers/order-created.event.ts
+import { handleEvent } from '@crossdelta/cloudevents'
+import { z } from 'zod'
+
+const OrderCreatedSchema = z.object({
+  type: z.literal('orders.created'),
+  orderId: z.string(),
+  total: z.number(),
+})
+
+export default handleEvent(OrderCreatedSchema, async (data) => {
+  await sendNotification(data)
+})
+```
+
+**📚 Learn more:** See `services/nats/README.md` in your workspace for monitoring, configuration, and JetStream details.
+
+<br />
+
+---
+
 ## 🛠 CLI Commands
 
 <details>
@@ -247,22 +307,9 @@ GitHub Secrets:
 - Pulumi CLI
 - Docker (for local Supabase/NATS)
 
-<br />
-
----
-
-## � Community & Support
-
-- 📖 [Full Documentation](https://github.com/orderboss/platform/tree/main/packages/platform-sdk/docs)
-- 🐛 [Report Issues](https://github.com/orderboss/platform/issues)
-- 💡 [Feature Requests](https://github.com/orderboss/platform/discussions)
-- 📦 [npm Package](https://www.npmjs.com/package/@crossdelta/platform-sdk)
-- ⭐ [Star on GitHub](https://github.com/orderboss/platform)
-
-<br />
 
 ---
 
-## �📄 License
+## 📄 License
 
 MIT © Crossdelta