Skip to content

feat: add demo gif to readme #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
martinabeleda merged 2 commits into from
Mar 14, 2026
Merged

feat: add demo gif to readme #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ce20bd
add demo gif to readme
martinabeleda Mar 14, 2026
bdee248
add demo tape
martinabeleda Mar 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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).
Expand All @@ -48,6 +44,9 @@ Run inside any git repo with uncommitted changes:

```
ripdiff

# or
rd
```

Or point it at a specific repo:
Expand Down
Binary file added docs/media/strava-demo.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions docs/strava-demo.tape
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Loading