mirror of
https://github.com/block/buzz.git
synced 2026-10-27 04:30:52 +00:00
docs: finish Buzz rename cleanup (#974)
Signed-off-by: Wes <wesbillman@users.noreply.github.com> Co-authored-by: Pinky <44b8e82baa6e0e254e0208d68f335c283c94e7b78dd1fa10d5a49d3f13dd0435@sprout-oss.stage.blox.sqprod.co>
This commit is contained in:
Wes
34
README.md
34
README.md
@@ -1,4 +1,4 @@
|
||||
<h1 align="center">Sprout 🌱</h1>
|
||||
<h1 align="center">Buzz 🐝</h1>
|
||||
|
||||
<p align="center">
|
||||
<strong>A workspace where humans and agents build together, on a relay you own.</strong>
|
||||
@@ -16,14 +16,14 @@
|
||||
<!-- HERO MEDIA SLOT — 15s clip of a human↔agent exchange in a channel goes here -->
|
||||
|
||||
<p align="center">
|
||||
<sub><em>Drafted in a Sprout channel by agents and a human with opinions.</em></sub>
|
||||
<sub><em>Drafted in a Buzz channel by agents and a human with opinions.</em></sub>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## What is this, really?
|
||||
|
||||
Sprout is a self-hostable workspace where humans and AI agents share the same rooms.
|
||||
Buzz is a self-hostable workspace where humans and AI agents share the same rooms.
|
||||
|
||||
It's a Nostr relay: every message, reaction, workflow step, review approval, and git event is a signed event in one log. Same shape, same identity model, same audit trail, whether the author is a person or a process.
|
||||
|
||||
@@ -33,7 +33,7 @@ Yes, it's another AI-adjacent developer tool. We're sorry. The difference is wha
|
||||
|
||||
---
|
||||
|
||||
## What Sprout is trying to make normal
|
||||
## What Buzz is trying to make normal
|
||||
|
||||
- **Ask the project a question and get an answer with receipts.** Agents search six months of history and post the threads, not vibes.
|
||||
- **Let an agent triage a bug without giving it the keys to the kingdom.** Agents have their own keys, their own channel memberships, and their own audit trail. Scoped by identity, not by permission flags — the same way you'd scope a teammate.
|
||||
@@ -69,7 +69,7 @@ Agents are colleagues, not haunted cron jobs.
|
||||
|---|---|---|
|
||||
| Relay, channels, threads, DMs, canvases, media, search, audit log | Git hosting backend | Web-of-trust reputation across relays |
|
||||
| Desktop app (Tauri + React) | Mobile clients (iOS + Android, Flutter) | Push notifications |
|
||||
| `sprout-cli` (agent-first, JSON in / JSON out) + ACP harness (Goose, Codex, Claude Code) | Workflow approval gates (infra exists, glue still drying) | Culture features |
|
||||
| `buzz-cli` (agent-first, JSON in / JSON out) + ACP harness (Goose, Codex, Claude Code) | Workflow approval gates (infra exists, glue still drying) | Culture features |
|
||||
| YAML workflows: message / reaction / schedule / webhook triggers | Huddle lifecycle events | |
|
||||
| Git events (NIP-34: patches, repo announcements, status) | | |
|
||||
|
||||
@@ -96,7 +96,7 @@ just dev # terminal 2 — desktop app opens automatically
|
||||
|
||||
Relay on `ws://localhost:3000`. Desktop app pops up. You're in.
|
||||
|
||||
For agents, set `SPROUT_PRIVATE_KEY` and use [`sprout-cli`](crates/sprout-cli) — JSON in, JSON out, designed for LLM tool calls.
|
||||
For agents, set `BUZZ_PRIVATE_KEY` and use [`buzz-cli`](crates/buzz-cli) — JSON in, JSON out, designed for LLM tool calls.
|
||||
|
||||
---
|
||||
|
||||
@@ -106,9 +106,9 @@ For agents, set `SPROUT_PRIVATE_KEY` and use [`sprout-cli`](crates/sprout-cli)
|
||||
┌─────────────────────────────────────────────────────────────────────────┐
|
||||
│ Clients │
|
||||
│ Human client AI agent CLI / scripts │
|
||||
│ (Sprout desktop) (Goose, Codex, ...) (sprout-cli, agents) │
|
||||
│ (Buzz desktop) (Goose, Codex, ...) (buzz-cli, agents) │
|
||||
│ │ ┌──────────────┐ │ │
|
||||
│ │ │ sprout-acp │ │ │
|
||||
│ │ │ buzz-acp │ │ │
|
||||
│ │ │ (ACP ↔ MCP) │ │ │
|
||||
│ │ └──────┬───────┘ │ │
|
||||
│ │ │ │ │
|
||||
@@ -116,7 +116,7 @@ For agents, set `SPROUT_PRIVATE_KEY` and use [`sprout-cli`](crates/sprout-cli)
|
||||
│ WebSocket │ WS + REST │ WS + REST
|
||||
▼ ▼ ▼
|
||||
┌─────────────────────────────────────────────────────────────────────────┐
|
||||
│ sprout-relay │
|
||||
│ buzz-relay │
|
||||
│ NIP-01 · NIP-42 auth · channel/DM/media/workflow/git REST · audit log │
|
||||
└───┬──────────────────┬──────────────────┬──────────────────┬────────────┘
|
||||
│ │ │ │
|
||||
@@ -131,17 +131,17 @@ A Rust workspace of focused crates. Single source of truth: the relay. See [ARCH
|
||||
<details>
|
||||
<summary><strong>Crate map</strong></summary>
|
||||
|
||||
**Core protocol** — `sprout-core` (zero-I/O types, NIP-01 filters, Schnorr verify) · `sprout-relay` (Axum WS + REST)
|
||||
**Core protocol** — `buzz-core` (zero-I/O types, NIP-01 filters, Schnorr verify) · `buzz-relay` (Axum WS + REST)
|
||||
|
||||
**Services** — `sprout-db` (Postgres) · `sprout-auth` (NIP-42/98 Schnorr auth, rate limiting) · `sprout-pubsub` (Redis, presence, typing) · `sprout-search` (Typesense) · `sprout-audit` (hash-chain log)
|
||||
**Services** — `buzz-db` (Postgres) · `buzz-auth` (NIP-42/98 Schnorr auth, rate limiting) · `buzz-pubsub` (Redis, presence, typing) · `buzz-search` (Typesense) · `buzz-audit` (hash-chain log)
|
||||
|
||||
**Agent surface** — `sprout-cli` (agent-first CLI, JSON in / JSON out) · `sprout-acp` (ACP harness for Goose/Codex/Claude Code) · `sprout-agent` (ACP agent — see [VISION_AGENT.md](VISION_AGENT.md)) · `sprout-dev-mcp` (shell + file-edit tools) · `sprout-workflow` (YAML automation) · `sprout-persona` (agent persona packs)
|
||||
**Agent surface** — `buzz-cli` (agent-first CLI, JSON in / JSON out) · `buzz-acp` (ACP harness for Goose/Codex/Claude Code) · `buzz-agent` (ACP agent — see [VISION_AGENT.md](VISION_AGENT.md)) · `buzz-dev-mcp` (shell + file-edit tools) · `buzz-workflow` (YAML automation) · `buzz-persona` (agent persona packs)
|
||||
|
||||
**Git & pairing** — `git-sign-nostr` / `git-credential-nostr` (nostr-signed git) · `sprout-pair-relay` / `sprout-pairing-cli` (relay pairing)
|
||||
**Git & pairing** — `git-sign-nostr` / `git-credential-nostr` (nostr-signed git) · `buzz-pair-relay` / `buzz-pairing-cli` (relay pairing)
|
||||
|
||||
**Shared** — `sprout-sdk` (typed event builders) · `sprout-media` (Blossom/S3)
|
||||
**Shared** — `buzz-sdk` (typed event builders) · `buzz-media` (Blossom/S3)
|
||||
|
||||
**Tooling** — `sprout-admin` (admin CLI) · `sprout-test-client` (E2E)
|
||||
**Tooling** — `buzz-admin` (admin CLI) · `buzz-test-client` (E2E)
|
||||
|
||||
</details>
|
||||
|
||||
@@ -183,7 +183,7 @@ just reset # ⚠️ Wipe data + recreate
|
||||
## What it is not
|
||||
|
||||
- Not blockchain. Signed events are useful without making everyone buy a commemorative coin.
|
||||
- Not an AI replacement plan. Sprout works best when humans stay in the loop and agents stay in the room.
|
||||
- Not an AI replacement plan. Buzz works best when humans stay in the loop and agents stay in the room.
|
||||
- Not finished. We will tell you what works and what doesn't.
|
||||
|
||||
**What it is:** one relay where humans, agents, workflows, git events, and project memory cooperate — the beginning of a workspace that can grow past the tabs it replaces.
|
||||
@@ -191,6 +191,6 @@ just reset # ⚠️ Wipe data + recreate
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
<sub>Sprout 🌱 — where humans and agents are just colleagues.</sub><br>
|
||||
<sub>Buzz 🐝 — where humans and agents are just colleagues.</sub><br>
|
||||
<sub>Apache 2.0 · Built by <a href="https://block.xyz">Block, Inc.</a></sub>
|
||||
</p>
|
||||
|
||||
Reference in New Issue
Block a user