Skip to content

Add animated demo GIF to README#184

Merged
rocketman-code merged 1 commit intomainfrom
docs/add-demo-gif
Mar 9, 2026
Merged

Add animated demo GIF to README#184
rocketman-code merged 1 commit intomainfrom
docs/add-demo-gif

Conversation

@rocketman-code
Copy link
Owner

Summary

  • Replace the static code block hero section with an animated terminal recording (637KB GIF)
  • Demo runs chainsaw on Cloudflare's workers-sdk monorepo, showing trace, --cut, and --chain on real data
  • Move Install section directly below the GIF to reduce friction
  • Include reproduction files: asciinema .cast, VHS .tape, and the shell script that drives the recording

Positioning rationale

The GIF sits in hero position (immediately after the tagline) following the pattern used by bat, fd, hyperfine, and delta. The static code example that was previously there is redundant with the GIF and has been removed -- detailed static examples remain in the Usage section below for reference and searchability.

Reproduction

Re-render the GIF at different sizes/themes:

# With agg (Rust, from asciinema)
agg docs/demo.cast docs/demo.gif --font-family "JetBrains Mono" --theme monokai

# With VHS (requires install)
vhs docs/demo.tape

Replace the static code block hero with an animated terminal recording
showing chainsaw on Cloudflare's workers-sdk monorepo. The demo walks
through trace, --cut, and --chain on real data.

Includes VHS tape for reproducible GIF rendering.
@rocketman-code rocketman-code merged commit 8930e7a into main Mar 9, 2026
7 checks passed
@rocketman-code rocketman-code deleted the docs/add-demo-gif branch March 9, 2026 02:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant