@jamesaphoenix/tx 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +69 -0
  2. package/package.json +3 -2
package/README.md ADDED
@@ -0,0 +1,69 @@
1
+ # @jamesaphoenix/tx
2
+
3
+ **TanStack for AI agents.** Headless primitives for memory, tasks, and orchestration.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @jamesaphoenix/tx better-sqlite3 effect
9
+ ```
10
+
11
+ ## Quick Start
12
+
13
+ ```typescript
14
+ import { createTx } from '@jamesaphoenix/tx'
15
+
16
+ // Initialize tx
17
+ const tx = createTx()
18
+
19
+ // Create a task
20
+ const task = await tx.add({
21
+ title: 'Implement feature X',
22
+ status: 'ready'
23
+ })
24
+
25
+ // Get next workable task
26
+ const next = await tx.ready()
27
+
28
+ // Complete a task
29
+ await tx.done(task.id)
30
+ ```
31
+
32
+ ## CLI Usage
33
+
34
+ ```bash
35
+ # Install globally
36
+ npm install -g @jamesaphoenix/tx
37
+
38
+ # Create tasks
39
+ tx add "Implement feature X"
40
+
41
+ # Get next ready task
42
+ tx ready
43
+
44
+ # Complete a task
45
+ tx done <task-id>
46
+
47
+ # View task tree
48
+ tx tree <task-id>
49
+ ```
50
+
51
+ ## Philosophy: Primitives, Not Frameworks
52
+
53
+ tx provides headless infrastructure for AI agent orchestration. You own your orchestration logic - tx owns the primitives.
54
+
55
+ | Primitive | Purpose |
56
+ |-----------|---------|
57
+ | `tx ready` | Get next workable task (unblocked, highest priority) |
58
+ | `tx claim <id>` | Mark task as being worked by an agent |
59
+ | `tx done <id>` | Complete task, potentially unblocking others |
60
+ | `tx block <id> <blocker>` | Declare dependencies |
61
+ | `tx handoff <id> --to <agent>` | Transfer task with context |
62
+
63
+ ## Documentation
64
+
65
+ Full documentation: [github.com/jamesaphoenix/tx](https://github.com/jamesaphoenix/tx)
66
+
67
+ ## License
68
+
69
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jamesaphoenix/tx",
3
- "version": "0.3.0",
3
+ "version": "0.4.0",
4
4
  "description": "TanStack for AI agents - headless primitives for memory, tasks, and orchestration",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -16,7 +16,8 @@
16
16
  }
17
17
  },
18
18
  "files": [
19
- "dist"
19
+ "dist",
20
+ "README.md"
20
21
  ],
21
22
  "scripts": {
22
23
  "build": "tsc -b",