diff --git a/README.md b/README.md index 0d95552..597a5ee 100644 --- a/README.md +++ b/README.md @@ -8,39 +8,42 @@

-image +

+ difi +

## Why difi? -- ⚡️ **Instant startup** — Built in Go, no background daemon. -- 🎨 **Structured review** — Tree view + side-by-side diffs. -- 🧠 **Editor-aware** — Jump to the exact line in `nvim` / `vim`. -- ⌨️ **Keyboard-first** — Designed for `h j k l`, no mouse. +**git diff** shows changes. **difi** helps you *review* them. -## Why not `git diff`? +- ⚡️ **Instant** — Built in Go. Launches immediately with no daemon or indexing. +- 🎨 **Structured** — A clean file tree and focused diffs for fast mental parsing. +- 🧠 **Editor-Aware** — Jump straight to the exact line in `nvim`/`vim` to fix issues. +- ⌨️ **Keyboard-First** — Navigate everything with `h j k l`. No mouse required. -- `git diff` is powerful, but it’s optimized for output — not review. -- difi is designed for the *moment before you push or open a PR*: +

(back to top)

## Installation -### Homebrew (macOS & Linux) +#### Homebrew (macOS & Linux) ```bash brew tap oug-t/difi brew install difi ``` -### Go Install +#### Go Install ```bash go install github.com/oug-t/difi/cmd/difi@latest ``` -### Manual (Linux / Windows) +#### Manual (Linux / Windows) - Download the binary from Releases and add it to your `$PATH`. +

(back to top)

+ ## Workflow - Run difi in any Git repository. @@ -51,6 +54,8 @@ cd my-project difi ``` +

(back to top)

+ ## Controls | Key | Action | @@ -61,8 +66,26 @@ difi | `e` / `Enter` | Edit file (opens editor at selected line) | | `?` | Toggle help drawer | | `q` | Quit | +

(back to top)

+## Integrations + +#### Neovim + +Get the ultimate review experience with **[difi.nvim](https://github.com/oug-t/difi.nvim)**. + +- **Auto-Open:** Instantly jumps to the file and line when you press `e` in the CLI. +- **Visual Diff:** Renders diffs inline with familiar green/red highlights—just like reviewing a PR on GitHub. +- **Interactive Review:** Restore a "deleted" line by simply removing the `-` marker. Discard an added line by deleting it entirely. +- **Context Aware:** Automatically syncs with your `difi` session target. + +

+ + Get difi.nvim + +

+ ## Contributing ```bash @@ -72,9 +95,10 @@ go run cmd/difi/main.go ``` Contributions are especially welcome in: -- diff rendering edge cases +- diff.nvim rendering edge cases - UI polish and accessibility - Windows support +

(back to top)

## Star History @@ -87,6 +111,7 @@ Contributions are especially welcome in: +

(back to top)

--- @@ -99,3 +124,4 @@ Contributions are especially welcome in: +