Skip to content

Commit 1459d80

Browse files
committed
docs: update README for v0.1.0 release
1 parent 059a794 commit 1459d80

1 file changed

Lines changed: 10 additions & 5 deletions

File tree

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@ Watch what your AI agent is changing, in real-time, right next to your terminal.
66

77
## Install
88

9+
Download the latest binary from [Releases](https://github.com/Astro-Han/diffpane/releases).
10+
11+
Or build from source:
12+
913
```bash
10-
brew install Astro-Han/tap/diffpane
14+
go install github.com/Astro-Han/diffpane@latest
1115
```
1216

13-
Or download from [Releases](https://github.com/Astro-Han/diffpane/releases).
14-
1517
## Usage
1618

1719
```bash
@@ -21,6 +23,8 @@ diffpane
2123

2224
Split your terminal. Left: run your AI agent. Right: `diffpane` shows what changed.
2325

26+
diffpane records your current git HEAD when it starts (the "baseline"). It watches for file changes and shows you a live unified diff of everything that changed since the baseline. When you `git commit`, the baseline auto-resets so you only see new changes.
27+
2428
## Keys
2529

2630
| Key | Action |
@@ -31,9 +35,10 @@ Split your terminal. Left: run your AI agent. Right: `diffpane` shows what chang
3135
| `Tab` | File list |
3236
| `q` | Quit |
3337

34-
## How it works
38+
## Requirements
3539

36-
diffpane records your current git HEAD when it starts (the "baseline"). It watches for file changes and shows you a live diff of everything that changed since the baseline. When you `git commit`, the baseline auto-resets so you only see new changes.
40+
- macOS (darwin/amd64 or darwin/arm64)
41+
- Git
3742

3843
## License
3944

0 commit comments

Comments
 (0)