@coji/durably 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,74 @@
+# @coji/durably
+
+Step-oriented resumable batch execution for Node.js and browsers using SQLite.
+
+**[Documentation](https://coji.github.io/durably/)** | **[GitHub](https://github.com/coji/durably)** | **[Live Demo](https://durably-demo.vercel.app)**
+
+## Features
+
+- Resumable batch processing with step-level persistence
+- Works in both Node.js and browsers
+- Uses SQLite for state management (better-sqlite3/libsql for Node.js, SQLite WASM for browsers)
+- Minimal dependencies - just Kysely and Zod as peer dependencies
+- Event system for monitoring and extensibility
+- Type-safe input/output with Zod schemas
+
+## Installation
+
+```bash
+# Node.js with better-sqlite3
+npm install @coji/durably kysely zod better-sqlite3
+
+# Node.js with libsql
+npm install @coji/durably kysely zod @libsql/client @libsql/kysely-libsql
+
+# Browser with SQLocal
+npm install @coji/durably kysely zod sqlocal
+```
+
+## Usage
+
+```ts
+import { createDurably } from '@coji/durably'
+import SQLite from 'better-sqlite3'
+import { SqliteDialect } from 'kysely'
+import { z } from 'zod'
+
+const dialect = new SqliteDialect({
+  database: new SQLite('local.db'),
+})
+
+const durably = createDurably({ dialect })
+
+const syncUsers = durably.defineJob(
+  {
+    name: 'sync-users',
+    input: z.object({ orgId: z.string() }),
+    output: z.object({ syncedCount: z.number() }),
+  },
+  async (context, payload) => {
+    const users = await context.run('fetch-users', async () => {
+      return api.fetchUsers(payload.orgId)
+    })
+
+    await context.run('save-to-db', async () => {
+      await db.upsertUsers(users)
+    })
+
+    return { syncedCount: users.length }
+  },
+)
+
+await durably.migrate()
+durably.start()
+
+await syncUsers.trigger({ orgId: 'org_123' })
+```
+
+## Documentation
+
+For full documentation, visit [coji.github.io/durably](https://coji.github.io/durably/).
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coji/durably",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Step-oriented resumable batch execution for Node.js and browsers using SQLite",
   "type": "module",
   "main": "./dist/index.js",
@@ -16,7 +16,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "keywords": [
     "batch",