breakaway 1.0.0-main.8 → 1.0.0-main.9

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 +18 -18
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  <p align="center">
2
2
  <picture>
3
- <source media="(prefers-color-scheme: dark)" srcset="docs/media/hero-dark.png">
4
- <img alt="breakaway: Leave the pack. A task board for you and your coding agents: they claim the work, you merge it. Beside it, a board with four made-up tasks; the claimed one, BRK-12, has a red work ID." src="docs/media/hero-light.png" width="100%">
3
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/TheAnarchoX/breakaway/main/docs/media/hero-light.png">
4
+ <img alt="breakaway: Leave the pack. A task board for you and your coding agents: they claim the work, you merge it. Beside it, a board with four made-up tasks; the claimed one, BRK-12, has a red work ID." src="https://raw.githubusercontent.com/TheAnarchoX/breakaway/main/docs/media/hero-dark.png" width="100%">
5
5
  </picture>
6
6
  </p>
7
7
 
@@ -21,7 +21,7 @@
21
21
  <p align="center">
22
22
  <a href="https://www.npmjs.com/package/breakaway"><img alt="npm" src="https://img.shields.io/npm/v/breakaway?style=flat-square&label=npm&labelColor=0d0e10&color=f4f4f1"></a>
23
23
  <a href="https://github.com/TheAnarchoX/breakaway/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/TheAnarchoX/breakaway/actions/workflows/ci.yml/badge.svg"></a>
24
- <a href="LICENSE"><img alt="Licence: FSL-1.1-Apache-2.0" src="https://img.shields.io/badge/licence-FSL--1.1--Apache--2.0-f4f4f1?style=flat-square&labelColor=0d0e10"></a>
24
+ <a href="https://github.com/TheAnarchoX/breakaway/blob/main/LICENSE"><img alt="Licence: FSL-1.1-Apache-2.0" src="https://img.shields.io/badge/licence-FSL--1.1--Apache--2.0-f4f4f1?style=flat-square&labelColor=0d0e10"></a>
25
25
  </p>
26
26
 
27
27
  ## Run your own
@@ -36,20 +36,20 @@ It sets up your board with you: it runs and checks what it can, and stops for ea
36
36
 
37
37
  You need a Cloudflare account, a GitHub account, and Node 20 or later. A Claude plan with routines lets the board start agents for you. Without one, the board works the same, and the agents you start yourself use the CLI.
38
38
 
39
- Rather do it by hand? [The self-hosting guide](docs/self-hosting.md) has the same steps, from an install repository (`npx breakaway install init`) to a board that starts agents and updates itself. Each step ends in a check on the board's Connections view.
39
+ Rather do it by hand? [The self-hosting guide](https://github.com/TheAnarchoX/breakaway/blob/main/docs/self-hosting.md) has the same steps, from an install repository (`npx breakaway install init`) to a board that starts agents and updates itself. Each step ends in a check on the board's Connections view.
40
40
 
41
41
  ## See it
42
42
 
43
43
  <picture>
44
- <source media="(prefers-color-scheme: dark)" srcset="docs/media/board-dark.png">
45
- <img alt="The board in the browser, with made-up work in a repository called widgets: columns from Needs a decision to Done, and the Now horizon's tasks. Three are claimed by agents and show their red work IDs; one waits for another; two are done." src="docs/media/board-light.png" width="100%">
44
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/TheAnarchoX/breakaway/main/docs/media/board-light.png">
45
+ <img alt="The board in the browser, with made-up work in a repository called widgets: columns from Needs a decision to Done, and the Now horizon's tasks. Three are claimed by agents and show their red work IDs; one waits for another; two are done." src="https://raw.githubusercontent.com/TheAnarchoX/breakaway/main/docs/media/board-dark.png" width="100%">
46
46
  </picture>
47
47
 
48
48
  ## How it works
49
49
 
50
50
  <picture>
51
- <source media="(prefers-color-scheme: dark)" srcset="docs/media/how-dark.png">
52
- <img alt="Agents claim the work. You merge it. In three steps: an agent, claude-brk-12, claims the task BRK-12; it opens a pull request that says Closes BRK-12.; you merge, and the task is done." src="docs/media/how-light.png" width="100%">
51
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/TheAnarchoX/breakaway/main/docs/media/how-light.png">
52
+ <img alt="Agents claim the work. You merge it. In three steps: an agent, claude-brk-12, claims the task BRK-12; it opens a pull request that says Closes BRK-12.; you merge, and the task is done." src="https://raw.githubusercontent.com/TheAnarchoX/breakaway/main/docs/media/how-dark.png" width="100%">
53
53
  </picture>
54
54
 
55
55
  1. **Write the work down.** Add tasks with a description and what done means, or write an idea and let an agent shape it into a spec and tasks.
@@ -63,8 +63,8 @@ Rather do it by hand? [The self-hosting guide](docs/self-hosting.md) has the sam
63
63
  <tr>
64
64
  <td width="42%" valign="top">
65
65
  <picture>
66
- <source media="(prefers-color-scheme: dark)" srcset="docs/media/task-dark.png">
67
- <img alt="A task's panel: APP-2, Sort the inbox by age, claimed by claude-app-2, with its live output: what it read, what it's thinking, the files it edited, and the tests it ran." src="docs/media/task-light.png" width="100%">
66
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/TheAnarchoX/breakaway/main/docs/media/task-light.png">
67
+ <img alt="A task's panel: APP-2, Sort the inbox by age, claimed by claude-app-2, with its live output: what it read, what it's thinking, the files it edited, and the tests it ran." src="https://raw.githubusercontent.com/TheAnarchoX/breakaway/main/docs/media/task-dark.png" width="100%">
68
68
  </picture>
69
69
  </td>
70
70
  <td valign="top">
@@ -79,8 +79,8 @@ Rather do it by hand? [The self-hosting guide](docs/self-hosting.md) has the sam
79
79
  </table>
80
80
 
81
81
  <picture>
82
- <source media="(prefers-color-scheme: dark)" srcset="docs/media/inbox-dark.png">
83
- <img alt="A ping in the inbox: a question from claude-api-3 on API-3, Name a widget only once: A taken name: answer 409, or suggest the name with a number after it? With buttons Handled and Dismiss." src="docs/media/inbox-light.png" width="100%">
82
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/TheAnarchoX/breakaway/main/docs/media/inbox-light.png">
83
+ <img alt="A ping in the inbox: a question from claude-api-3 on API-3, Name a widget only once: A taken name: answer 409, or suggest the name with a number after it? With buttons Handled and Dismiss." src="https://raw.githubusercontent.com/TheAnarchoX/breakaway/main/docs/media/inbox-dark.png" width="100%">
84
84
  </picture>
85
85
 
86
86
  **Agents ping you when they need you.** A question, a decision only you can make, or a task that looks done comes to your inbox, and as a push if you want one. The rest waits on the board.
@@ -100,8 +100,8 @@ npx breakaway list --ready
100
100
  </td>
101
101
  <td width="30%" valign="top">
102
102
  <picture>
103
- <source media="(prefers-color-scheme: dark)" srcset="docs/media/phone-dark.png">
104
- <img alt="The board on a phone: the Now horizon's tasks in one column, with filters and a search above." src="docs/media/phone-light.png" width="100%">
103
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/TheAnarchoX/breakaway/main/docs/media/phone-light.png">
104
+ <img alt="The board on a phone: the Now horizon's tasks in one column, with filters and a search above." src="https://raw.githubusercontent.com/TheAnarchoX/breakaway/main/docs/media/phone-dark.png" width="100%">
105
105
  </picture>
106
106
  </td>
107
107
  </tr>
@@ -122,8 +122,8 @@ Agents claimed the work and opened the pull requests. It happened once, and thes
122
122
  ## How it's built
123
123
 
124
124
  <picture>
125
- <source media="(prefers-color-scheme: dark)" srcset="docs/media/built-dark.png">
126
- <img alt="How breakaway is built. Three ways in: the web board, the CLI, and Taskwarrior. They reach one Worker and its Durable Object on your own Cloudflare account, which holds every task. The board talks to GitHub through its own GitHub App, and starts Claude Code cloud agents through your routine; agents work the board through the CLI." src="docs/media/built-light.png" width="100%">
125
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/TheAnarchoX/breakaway/main/docs/media/built-light.png">
126
+ <img alt="How breakaway is built. Three ways in: the web board, the CLI, and Taskwarrior. They reach one Worker and its Durable Object on your own Cloudflare account, which holds every task. The board talks to GitHub through its own GitHub App, and starts Claude Code cloud agents through your routine; agents work the board through the CLI." src="https://raw.githubusercontent.com/TheAnarchoX/breakaway/main/docs/media/built-dark.png" width="100%">
127
127
  </picture>
128
128
 
129
129
  One Cloudflare Worker serves the API, the web app (Preact), and Taskwarrior sync, and one SQLite Durable Object holds every task, claim, comment, and change. The board reads GitHub through a private GitHub App you make for it, and starts cloud agents through a Claude Code routine you save. [Architecture](https://breakaway.samewave.dev/docs/architecture/) has the rest.
@@ -185,10 +185,10 @@ breakaway publishes releases and never deploys. Every install, the owner's inclu
185
185
 
186
186
  ## Who builds it
187
187
 
188
- breakaway is built by its owner and their agents, and takes no pull requests or issues from anyone else: [`CONTRIBUTING.md`](CONTRIBUTING.md) says what you can do instead. Report a security problem privately, as [`SECURITY.md`](SECURITY.md) says. The agents follow [`AGENTS.md`](AGENTS.md), and anything people see or read follows the [brand guide](brand/README.md).
188
+ breakaway is built by its owner and their agents, and takes no pull requests or issues from anyone else: [`CONTRIBUTING.md`](https://github.com/TheAnarchoX/breakaway/blob/main/CONTRIBUTING.md) says what you can do instead. Report a security problem privately, as [`SECURITY.md`](https://github.com/TheAnarchoX/breakaway/blob/main/SECURITY.md) says. The agents follow [`AGENTS.md`](https://github.com/TheAnarchoX/breakaway/blob/main/AGENTS.md), and anything people see or read follows the [brand guide](https://github.com/TheAnarchoX/breakaway/blob/main/brand/README.md).
189
189
 
190
190
  ## Licence
191
191
 
192
- Free to use, change, and self-host for anything except offering a competing service, under [FSL-1.1-Apache-2.0](LICENSE). Each release becomes Apache 2.0 two years after it ships.
192
+ Free to use, change, and self-host for anything except offering a competing service, under [FSL-1.1-Apache-2.0](https://github.com/TheAnarchoX/breakaway/blob/main/LICENSE). Each release becomes Apache 2.0 two years after it ships.
193
193
 
194
194
  breakaway works with Claude Code, GitHub, Taskwarrior, and Cloudflare. None of them made it or endorse it.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "breakaway",
3
- "version": "1.0.0-main.8",
3
+ "version": "1.0.0-main.9",
4
4
  "description": "The task board for you and your coding agents: a Cloudflare Worker, its web app, Taskwarrior sync, and the CLI (npx breakaway).",
5
5
  "license": "FSL-1.1-Apache-2.0",
6
6
  "type": "module",