@pi-archimedes/diff 2.5.1 → 2.6.3

package/README.md

@@ -1,49 +1,58 @@
 # @pi-archimedes/diff
 
-Shiki-powered diff rendering for the [Pi coding agent](https://github.com/earendil-works/pi).
+**See what changed. Not just that something changed.**
 
-Syntax-highlighted, word-level diffs make reviewing code changes effortless. By rendering clear side-by-side or unified diffs directly in your terminal with themes matched to your environment, code modifications can be inspected at a glance before committing.
-
-## What you get
-
-- **Split and unified views** — side-by-side split diff or traditional unified view, auto-selected based on terminal width
-- **Shiki syntax highlighting** — full syntax highlighting powered by [Shiki](https://shiki.style), with auto-derived theme colors
-- **Word-level emphasis** — changed characters within lines are highlighted at word level for precise change tracking
-- **Graceful fallback** — falls back to plain text diff when Shiki is unavailable or the language is unrecognized
-- **Configurable thresholds** — control minimum terminal width for split view and minimum code width per side
-
-## Screenshots
-
-### Split diff view
-
-Side-by-side diff with syntax highlighting, word-level emphasis on changed characters, and line numbers:
-
-![diff edit](../../docs/images/diff-edit.png)
+Raw text diffs make it easy to miss the one line that matters. Diff puts [Shiki](https://shiki.style)-syntax-highlighted changes in front of you — side by side when there's room, unified when there isn't — with word-level emphasis on the parts that actually moved inside each line.
 
 ## Install
 
+Standalone:
+
 ```bash
 pi install npm:@pi-archimedes/diff
 ```
 
-Or install full meta package:
+Or the full suite instead:
 
 ```bash
 pi install npm:pi-archimedes
 ```
 
-## Settings
+New to Pi? Pi itself is a one-time global install and needs Node.js ≥ 22.19.0:
+
+```bash
+npm install -g --ignore-scripts @earendil-works/pi-coding-agent
+```
+
+After installing Pi, choose one installation command above, then `cd` into your project and run `pi`. Inside the session, `/login` signs you in and `/model` picks a model — the [setup section](https://github.com/danielcherubini/pi-archimedes#setup) walks through the first run. A running session picks the diff renderer up with `/reload`.
+
+<div align="center">
+  <img src="https://raw.githubusercontent.com/danielcherubini/pi-archimedes/main/docs/images/diff-edit.png" width="700" alt="Shiki syntax-highlighted split diff">
+</div>
+
+## What you get
+
+- **Split view, and unified when it isn't** — side-by-side diffs when the terminal is wide enough; a traditional unified view when it isn't. The choice is made automatically from the column width.
+- **Syntax highlighting** — language-aware colouring of the diff body, from a Shiki theme.
+- **Word-level emphasis** — sub-line highlighting that shows exactly which tokens changed inside an otherwise similar line.
+- **Graceful fallback** — when Shiki is unavailable or the format isn't recognised, the change is shown as a plain text diff.
+
+## What it does (and doesn't) do
+
+The renderer displays `edit` and `write` tool changes in the tool UI, including call previews. It is **not an approval gate** — it helps you read changes as they happen; it doesn't hold changes back.
+
+## Appearance
+
+Standalone, the renderer runs on fixed defaults — the `github-dark` theme, a 150-column minimum for split view, and 60 code columns per side — and it does **not** read settings, because standalone has no config reader. In the [suite](https://github.com/danielcherubini/pi-archimedes), its `archimedes.diff` namespace supplies the same three values (`diffTheme`, `diffSplitMinWidth`, `diffSplitMinCodeWidth`) through the suite's config reader:
 
 | Setting | Type | Default | Description |
 |---------|------|---------|-------------|
 | `diffTheme` | string | `github-dark` | Shiki syntax-highlighting theme |
-| `diffSplitMinWidth` | number | `150` | Minimum terminal columns to show split diff view (≥ 100) |
+| `diffSplitMinWidth` | number | `150` | Minimum terminal columns for split view (≥ 100) |
 | `diffSplitMinCodeWidth` | number | `60` | Minimum code columns per side in split view (≥ 30) |
 
-Settings are stored in `~/.pi/agent/settings.json` under the `archimedes.diff` namespace.
-
-## Integration
+The palette is derived from the chosen Shiki theme; it does **not** automatically pick up Pi's active theme colours. If you want a different look, pick a closer theme rather than expecting a live match.
 
-When installed via `pi-archimedes` (the meta package), the diff tools are registered with callbacks to the current theme and config, ensuring colors match your active Pi theme. Standalone installs use default dark theme colors.
+On/off is managed by the suite: toggle via `/plugins` (`archimedes.diff.enabled`, default on).
 
-← Back to [pi-archimedes](../../README.md)
+← [Back to pi-archimedes](https://github.com/danielcherubini/pi-archimedes)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pi-archimedes/diff",
-  "version": "2.5.1",
+  "version": "2.6.3",
   "type": "module",
   "keywords": [
     "pi-package"
@@ -24,8 +24,8 @@
     "@earendil-works/pi-tui": ">=0.1.0"
   },
   "devDependencies": {
-    "@earendil-works/pi-coding-agent": "^0.84.4",
-    "@earendil-works/pi-tui": "^0.84.4",
+    "@earendil-works/pi-coding-agent": "^0.85.1",
+    "@earendil-works/pi-tui": "^0.85.1",
     "@types/diff": "^7.0.2",
     "typescript": "^6.0.0"
   },