Skip to content

docs: improve README #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


# beflow

**An AI-agent orchestration CLI for governed autonomy — drives your backlog to
Expand Down Expand Up @@ -52,8 +54,8 @@ flowchart LR

- **[Bun](https://bun.sh)** ≥ 1.0 — beflow runs on the Bun runtime.
- A **coding-agent CLI** that speaks [ACP](https://agentclientprotocol.com)
(e.g. `claude`) plus [`acpx`](https://www.npmjs.com/package/acpx) (fetched
automatically via `bunx`).
(e.g. `claude`) plus [`acpx`](https://www.npmjs.com/package/acpx) (default
`bunx acpx`, configurable under `tools.acpx`).
- **`git`** and the **`gh`** CLI (for the PR step).
- A **Plane** or **Linear** workspace and a personal API token.

Expand Down