@withbuddi/buddi 0.1.0-pre.17 → 0.1.0-pre.18

package/README.md

@@ -1,6 +1,8 @@
 # buddi
 
-<img src="packages/web/public/mascot/core.png" alt="The Buddi Blob, buddi's mascot" width="160" align="right">
+<img src="https://raw.githubusercontent.com/withbuddi/buddi/main/packages/web/public/mascot/core.png" alt="The Buddi Blob, buddi's mascot" width="160" align="right">
+
+[withbuddi.com](https://withbuddi.com) · [npm](https://www.npmjs.com/package/@withbuddi/buddi) · [docs](docs/README.md)
 
 buddi is a personal agent platform you run on your own machine. An agent is a
 markdown file: a front matter that names the tools it may call, and a body that
@@ -110,6 +112,8 @@ script.
 - "Take a screenshot of example.com." It opens its own browser, asks you
   first, and shows the page on the canvas beside the chat.
 - Drop a PDF or a CSV on the chat and ask about it.
+- Click the camera in the composer, pick another tab of your browser, and ask
+  about what it shows.
 - "Every Friday at 6, send me a recap of the week." A mission, on a schedule.
 
 **A mailbox.** In Settings → Email, add an account with its address and an app
@@ -160,7 +164,7 @@ runs on a timer, and the hosts it talks to. Nothing happens until you approve.
 own, such as sending mail, running a command or acting in a browser, stops the
 run and shows a card with exactly what will happen. You approve or reject it
 on the dashboard or on Telegram. Unknown tools, bad arguments and missing
-configuration never run. [ARCHITECTURE.md](ARCHITECTURE.md) has the model.
+configuration never run. [docs/architecture.md](docs/architecture.md) has the model.
 
 **Missions and watchers.** A mission is scheduled work. A watcher checks
 something on an interval and produces findings; core decides whether a finding
@@ -246,22 +250,14 @@ Most of this is on the dashboard. From a terminal:
 | Command | What it does |
 | --- | --- |
 | `buddi` | open the dashboard (the first run sets everything up) |
-| `buddi doctor` | check every moving part and say what is wrong |
-| `buddi service status` | is the background service running? `restart`, `logs`, `stop` too |
-| `buddi dashboard` | a five-minute sign-in link to the dashboard |
-| `buddi upgrade` | back up, install the new version, migrate, restart |
-| `buddi backup create --encrypt` | one archive now, sealed with your passphrase |
-| `buddi browser install` | download Chromium for the agents' browser |
-| `buddi agents` | every agent, its engine, and whether it can run |
+| `buddi status` | one screen: service, database, agents, what needs you |
+| `buddi ask "…"` | one question, one answer, then exit; `--json` for scripts |
 | `buddi chat` | talk to the default agent in the terminal |
-| `buddi ask "…"` | one question, one answer, then exit |
-| `buddi telegram pair` | a QR code that pairs a phone |
-| `buddi reminders` | what the agents have put on the clock |
-| `buddi plugins list` | what is installed |
-| `buddi mcp` | buddi as an MCP server, for Claude Code |
+| `buddi upgrade` | back up, install the new version, migrate, restart |
+| `buddi backup create` | one archive of everything, now |
 
-`buddi help` prints them all. `buddi status` is `buddi doctor` under another
-name.
+`buddi help` lists every command, and `buddi help <command>` explains one.
+The whole tree is in [docs/cli.md](docs/cli.md).
 
 ---
 
@@ -327,7 +323,13 @@ A tag `v<version>` runs the gate, builds the tarball, publishes it to npm
 (pre-release versions under `next`, others under `latest`) and creates the
 GitHub release.
 
-Read next: [ARCHITECTURE.md](ARCHITECTURE.md) for the design,
+**Changelog.** Every change an owner or plugin author could notice gets a line
+under Unreleased in `CHANGELOG.md`, in the same commit; CI refuses a change to
+`packages/*/src` without one unless the commit message says `[no changelog]`.
+Before a tag, `node scripts/release/changelog.mjs cut <version>` turns
+Unreleased into that version's section, which the release lifts into its notes.
+
+Read next: [docs/architecture.md](docs/architecture.md) for the design,
 [docs/plugins.md](docs/plugins.md) to write a plugin, and
 [docs/README.md](docs/README.md) for the index of everything else. The roadmap
 is kept outside this repository.