diff --git a/README.md b/README.md index c016032..4bca090 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,7 @@

- A calm, focused way to review Git diffs.
- Review code with clarity. Polish before you push. + A calm, focused way to review Git diffs.

@@ -16,10 +15,15 @@ ## Why difi? -- ⚑️ **Blazing Fast** β€” Built in Go. Starts instantly. -- 🎨 **Semantic UI** β€” Split-pane layout with syntax highlighting and Nerd Font icons. -- 🧠 **Context Aware** β€” Opens your editor (nvim/vim) at the exact line you are reviewing. -- ⌨️ **Vim Native** β€” Navigate with `h j k l`. Zero mouse required. +- ⚑️ **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. + +## Why not `git diff`? + +- `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*: ## Installation @@ -30,8 +34,6 @@ brew tap oug-t/difi brew install difi ``` -## Installation - ### Go Install ```bash @@ -40,7 +42,7 @@ go install github.com/oug-t/difi/cmd/difi@latest ### Manual (Linux / Windows) -- Download the binary from Releases and add it to your $PATH. +- Download the binary from Releases and add it to your `$PATH`. ## Workflow @@ -62,18 +64,34 @@ difi | `e` / `Enter` | Edit file (opens editor at selected line) | | `?` | Toggle help drawer | | `q` | Quit | +

(back to top)

## Contributing -- PRs are welcome! -- We use Bubble Tea for the TUI. - ```bash git clone https://github.com/oug-t/difi cd difi go run cmd/difi/main.go ``` +Contributions are especially welcome in: +- diff rendering edge cases +- UI polish and accessibility +- Windows support +

(back to top)

+ +## Star History + + + + + + Star History Chart + + +

(back to top)

+ ---

Made with ❀️ by oug-t

+