diff --git a/README.md b/README.md index dd991cf..1db0c70 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,8 @@ A terminal UI for watching and reviewing agent progress, designed for a tmux pan Uses [difftastic](https://difftastic.wilfred.me/) for structural, syntax-aware diffs with ANSI color output via an in-process Rust dependency. +![ripdiff demo](docs/media/strava-demo.gif) + ## Install ### Install from crates.io @@ -32,12 +34,6 @@ This installs `ripdiff` into `~/.cargo/bin/`. cargo install --path . ``` -For best results, install difftastic: - -```bash -cargo install difftastic -``` - ## Releasing Maintainer release instructions live in [RELEASING.md](/home/mabeleda/Development/ripdiff/RELEASING.md). @@ -48,6 +44,9 @@ Run inside any git repo with uncommitted changes: ``` ripdiff + +# or +rd ``` Or point it at a specific repo: diff --git a/docs/media/strava-demo.gif b/docs/media/strava-demo.gif new file mode 100644 index 0000000..7430c0f Binary files /dev/null and b/docs/media/strava-demo.gif differ diff --git a/docs/strava-demo.tape b/docs/strava-demo.tape new file mode 100644 index 0000000..a86cb9d --- /dev/null +++ b/docs/strava-demo.tape @@ -0,0 +1,32 @@ +Output docs/media/strava-demo.gif + +Set Shell "zsh" +Set Width 1800 +Set Height 1000 +Set FontSize 20 +Set Padding 24 +Set TypingSpeed 0ms + +Type "rd --path ~/Development/strava" +Enter +Sleep 2s + +Down +Sleep 600ms + +Type "t" +Sleep 1000ms + +Down +Sleep 600ms +Down +Sleep 600ms +Down +Sleep 400ms +Down +Sleep 400ms +Down +Sleep 700ms + +Type "t" +Sleep 1s