Skip to content

Improve animated README demo - #23

Merged
HoungDev merged 1 commit into
mainfrom
agent/improve-readme-demo
Aug 7, 2026
Merged

HoungDev merged 1 commit into
mainfrom
agent/improve-readme-demo

Conversation

@HoungDev

@HoungDev HoungDev commented Aug 7, 2026

Copy link
Copy Markdown
Owner

What changed

  • animate each real CLI command with a compact typing sequence
  • reveal captured title, tag, and dry-run rename output line by line
  • keep the loop to about seven seconds (25 frames, 900×506, ~275 KB)
  • use a branch-aware relative README asset link
  • document how the animation is produced and reproduced

Why

The previous demo contained only three long static frames. A short terminal animation communicates
the workflow faster while preserving truthful, reproducible output from the current source tree.

Impact

Visitors can understand the title, tag, and safe rename workflows directly from the README.
Contributors can still rebuild the tracked GIF with the existing renderer command.

Validation

  • ruff check .
  • ruff format --check .
  • pytest --basetemp .test-tmp-pytest — 85 passed, 94.02% coverage
  • rebuilt GIF SHA-256 matches the tracked asset
  • visual review of typing, output, and final frames

@HoungDev
HoungDev marked this pull request as ready for review August 7, 2026 10:11
@HoungDev
HoungDev merged commit 75a89c9 into main Aug 7, 2026
7 checks passed
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