@bobtail.software/b-durable 1.0.4 → 1.0.5

package/README.md

@@ -1,8 +1,8 @@
 
 # `@bobtail.software/b-durable`: Composable, Type-Safe, Durable Workflows for TypeScript
 
-[![npm version](https://badge.fury.io/js/@bobtail.software/b-durable.svg)](https://badge.fury.io/js/@bobtail.software/b-durable)
-[![License: GPL-3.0](https://img.shields.io/badge/License-GPL--3.0-yellow.svg)](https://opensource.org/licenses/GPL-3.0)
+![NPM Version](https://img.shields.io/npm/v/@bobtail.software/b-durable.svg)
+![License](https://img.shields.io/npm/l/@bobtail.software/eslint-plugin-b-durable.svg)
 
 `b-durable` is a powerful system that transforms standard `async` functions into **composable, interactive, durable, and resilient workflows**. It lets you write long-running business logic—spanning hours, days, or months—as simple, linear `async/await` code. The system handles state persistence, orchestration, external events, and crash recovery, allowing you to focus on your business logic.
 
@@ -172,14 +172,29 @@ async function main() {
     blockingRedisClient: blockingRedis,
   });
 
-  console.log('Durable system ready. Starting workflow...');
+  console.log('Durable system ready. Starting workflows...');
 
-  const workflowId = await durableSystem.start(userOnboardingWorkflow, {
-    userId: `user-${Date.now()}`,
-    email: 'test.user@example.com',
+  // --- Start a workflow with a system-generated ID ---
+  const workflowId1 = await durableSystem.start(userOnboardingWorkflow, {
+    input: {
+      userId: `user-${Date.now()}`,
+      email: 'test.user@example.com',
+    }
+  });
+  console.log(`Workflow ${workflowId1} started.`);
+
+  // --- Start a workflow with a predictable, user-provided ID ---
+  const orderId = `order-abc-123`;
+  const workflowId2 = await durableSystem.start(userOnboardingWorkflow, {
+    workflowId: orderId,
+    input: {
+      userId: 'user-from-order-123',
+      email: 'customer@example.com',
+    }
   });
-  
-  console.log(`Workflow ${workflowId} started.`);
+  console.log(`Workflow started with predictable ID: ${workflowId2}`);
+  // Now you can easily send events using the 'orderId'
+  // durableSystem.sendEvent(..., orderId, ...);
 }
 
 main().catch(console.error);