bunqueue 1.3.0 → 1.3.1

package/README.md

@@ -24,9 +24,45 @@
 
 ---
 
+## Why bunqueue?
+
+> ⚠️ **Bun only** — bunqueue requires [Bun](https://bun.sh) runtime. Node.js is not supported.
+
+**Every other job queue requires external infrastructure.** bunqueue doesn't.
+
+| Library | Requires |
+|---------|----------|
+| BullMQ | ❌ Redis |
+| Agenda | ❌ MongoDB |
+| Bee-Queue | ❌ Redis |
+| pg-boss | ❌ PostgreSQL |
+| Celery | ❌ Redis/RabbitMQ |
+| **bunqueue** | ✅ **Nothing. Zero. Nada.** |
+
+bunqueue is the **only** job queue with:
+- **BullMQ-compatible API** — Same `Queue`, `Worker`, `QueueEvents` you know
+- **Zero external dependencies** — No Redis, no MongoDB, no nothing
+- **Persistent storage** — SQLite survives restarts, no data loss
+- **100K+ jobs/sec** — Faster than Redis-based queues
+- **Single file deployment** — Just your app, that's it
+
+```bash
+# Others: Install Redis, configure connection, manage infrastructure...
+# bunqueue:
+bun add bunqueue
+```
+
+```typescript
+import { Queue, Worker } from 'bunqueue/client';
+// That's it. You're done. Start queuing.
+```
+
+---
+
 ## Quick Install
 
 ```bash
+# Requires Bun runtime (https://bun.sh)
 bun add bunqueue
 ```
 
@@ -462,6 +498,52 @@ Supported providers: AWS S3, Cloudflare R2, MinIO, DigitalOcean Spaces.
 | Multiple languages | **Server** (HTTP API) |
 | Horizontal scaling | **Server** |
 
+### Server Mode SDK
+
+For communicating with bunqueue server from **separate processes**, use the [flashq](https://www.npmjs.com/package/flashq) SDK:
+
+```bash
+bun add flashq
+```
+
+```typescript
+import { FlashQ } from 'flashq';
+
+const client = new FlashQ({ host: 'localhost', port: 6789 });
+
+// Push job
+await client.push('emails', { to: 'user@test.com' });
+
+// Pull and process
+const job = await client.pull('emails');
+if (job) {
+  console.log('Processing:', job.data);
+  await client.ack(job.id);
+}
+```
+
+| Package | Use Case |
+|---------|----------|
+| `bunqueue/client` | Same process (embedded) |
+| `flashq` | Different process (TCP client) |
+
+```
+┌─────────────────┐          ┌─────────────────┐
+│   Your App      │          │   Your App      │
+│                 │          │                 │
+│  bunqueue/client│          │     flashq      │
+│  (embedded)     │          │   (TCP client)  │
+└────────┬────────┘          └────────┬────────┘
+         │                            │
+         │                            ▼
+         │                   ┌─────────────────┐
+         │                   │ bunqueue server │
+         │                   │   (port 6789)   │
+         │                   └─────────────────┘
+         │
+    Same process              Different process
+```
+
 ---
 
 ## Architecture

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bunqueue",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "High-performance job queue server written in Bun. SQLite persistence, cron scheduling, priorities, retries, DLQ, webhooks. Minimal dependencies.",
   "type": "module",
   "main": "dist/main.js",