@diffohq/diffo 0.0.1 → 0.1.0

package/README.md

@@ -1,9 +1,3 @@
-> [!IMPORTANT]
-> **Diffo is pre-release.** The loop works end to end and this repo is reviewed with it
-> daily. The skill installs from this repository; the CLI it runs comes from npm as
-> **`@diffohq/diffo`** — scoped because the bare `diffo` name belongs to an unrelated
-> package. See [Status](#status) for what works today.
-
 <div align="center">
 
 <a href="https://diffohq.github.io/diffo/">
@@ -23,6 +17,7 @@ come back as fixes.
 [Quick start](#quick-start) · [Why Diffo](#why-diffo) · [Docs](#docs) · [Status](#status) · [Contributing](#contributing)
 
 [![CI](https://img.shields.io/github/actions/workflow/status/DiffoHQ/diffo/ci.yml?branch=main&label=CI)](https://github.com/DiffoHQ/diffo/actions/workflows/ci.yml)
+[![npm](https://img.shields.io/npm/v/%40diffohq%2Fdiffo?label=npm&color=cb3837)](https://www.npmjs.com/package/@diffohq/diffo)
 [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
 [![Node](https://img.shields.io/badge/node-%E2%89%A5%2024-brightgreen)](#quick-start)
 [![Docs](https://img.shields.io/badge/docs-diffo-8b5cf6)](https://diffohq.github.io/diffo/)
@@ -83,7 +78,7 @@ node dist/cli.mjs setup   # or `node dist/cli.mjs` from any repo to review it
 
 </details>
 
-New here? [**Your first review, end to end**](docs/tutorial.md) takes about five minutes.
+New here? [**Your first review, end to end**](https://diffohq.github.io/diffo/tutorial) takes about five minutes.
 
 ## Why Diffo
 
@@ -114,9 +109,9 @@ The judgement stays yours. You just stop reading alone.
 
 **A thread is a decision**
 
-Each comment is one small call: change this, explain that, leave it alone. Mark it a Change
-or a Question and the agent is told which. The review is the sum of those decisions, not a
-verdict at the end.
+Each comment is one small call: change this, explain that, leave it alone. Drop it on a
+line or drag down the gutter for a range of them. Mark it a Change or a Question and the
+agent is told which. The review is the sum of those decisions, not a verdict at the end.
 
 </td>
 <td width="50%">
@@ -205,14 +200,14 @@ cheapest to change.
 
 | | |
 | --- | --- |
-| [**Your first review**](docs/tutorial.md) | The whole loop end to end, about five minutes |
-| [**Getting started**](docs/guide/getting-started.md) | Install, and where each agent gets wired |
-| [**The review loop**](docs/guide/the-loop.md) | Reading, commenting, and what the agent receives |
-| [**How it works**](docs/guide/how-it-works.md) | The components and the server lifecycle |
-| [**The agent side**](docs/agents.md) | The agent protocol: every command, every payload |
-| [**Architecture**](docs/architecture.md) | Diff pipeline, delivery queue, SQLite state |
-| [**CLI**](docs/reference/cli.md) and [**Keyboard shortcuts**](docs/reference/keyboard-shortcuts.md) | Reference |
-| [**FAQ**](docs/faq.md) | The short answers |
+| [**Your first review**](https://diffohq.github.io/diffo/tutorial) | The whole loop end to end, about five minutes |
+| [**Getting started**](https://diffohq.github.io/diffo/guide/getting-started) | Install, and where each agent gets wired |
+| [**The review loop**](https://diffohq.github.io/diffo/guide/the-loop) | Reading, commenting, and what the agent receives |
+| [**How it works**](https://diffohq.github.io/diffo/guide/how-it-works) | The components and the server lifecycle |
+| [**The agent side**](https://diffohq.github.io/diffo/agents) | The agent protocol: every command, every payload |
+| [**Architecture**](https://diffohq.github.io/diffo/architecture) | Diff pipeline, delivery queue, SQLite state |
+| [**CLI**](https://diffohq.github.io/diffo/reference/cli) and [**Keyboard shortcuts**](https://diffohq.github.io/diffo/reference/keyboard-shortcuts) | Reference |
+| [**FAQ**](https://diffohq.github.io/diffo/faq) | The short answers |
 
 ## Under the hood
 
@@ -223,7 +218,7 @@ there is no database to install. **Zero network calls.** 859 tests across 54 fil
 
 Reviews are scoped per repo **and branch**, and the server is loopback-only, rejecting
 non-loopback `Host` and `Origin` headers so a web page can't reach into your repo through
-it. The full walkthrough is in [**Architecture**](docs/architecture.md).
+it. The full walkthrough is in [**Architecture**](https://diffohq.github.io/diffo/architecture).
 
 <details>
 <summary><b>Why read marks survive a live diff</b></summary>
@@ -254,12 +249,13 @@ we commit to: **anything that runs on your machine for one reviewer is core.**
 
 ## Status
 
-What works today:
+Diffo is pre-1.0: the loop below works end to end — this repo is reviewed with it
+daily — and the edges are still moving. What works today:
 
-- [x] [Live review of any changeset](docs/guide/how-it-works.md): the working tree, or anything since `--base`.
-- [x] [The comment loop](docs/guide/the-loop.md): threads that reach the session that wrote the code.
-- [x] [One setup, every agent](docs/guide/getting-started.md): Claude Code, Codex, Cursor, VS Code, Copilot CLI, Gemini CLI, Amp, Goose, OpenCode.
-- [x] [Reading tools](docs/reference/keyboard-shortcuts.md): unified and split diffs, word-level marks, coverage tracking.
+- [x] [Live review of any changeset](https://diffohq.github.io/diffo/guide/how-it-works): the working tree, or anything since `--base`.
+- [x] [The comment loop](https://diffohq.github.io/diffo/guide/the-loop): threads that reach the session that wrote the code.
+- [x] [One setup, every agent](https://diffohq.github.io/diffo/guide/getting-started): Claude Code, Codex, Cursor, VS Code, Copilot CLI, Gemini CLI, Amp, Goose, OpenCode.
+- [x] [Reading tools](https://diffohq.github.io/diffo/reference/keyboard-shortcuts): unified and split diffs, word-level marks, coverage tracking.
 
 ## Contributing
 
@@ -282,11 +278,9 @@ on your first pull request, and signing is one reply.
 Found a security problem? Please don't open a public issue. The
 [Security Policy](SECURITY.md) says where to send it and what's in scope.
 
-<!-- Contributors grid: contrib.rocks 404s until DiffoHQ/diffo is public. Uncomment at launch.
 <a href="https://github.com/DiffoHQ/diffo/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=DiffoHQ/diffo" alt="Contributors">
 </a>
--->
 
 ## License & trademark