Skip to content

docs: add animated demo to README#1340

Open
dobestan wants to merge 1 commit intoXAMPPRocky:masterfrom
dobestan:docs/add-demo-gif
Open

docs: add animated demo to README#1340
dobestan wants to merge 1 commit intoXAMPPRocky:masterfrom
dobestan:docs/add-demo-gif

Conversation

@dobestan
Copy link
Copy Markdown

@dobestan dobestan commented Mar 19, 2026

Summary

Adds an animated terminal recording to the README's Example section, complementing the existing static output. The GIF demonstrates:

  • Basic tokei output with language breakdown
  • tokei --sort code for sorting by lines of code
  • tokei -t TypeScript for filtering specific languages

Why

The existing static code block is helpful but doesn't convey the speed and interactivity of running tokei. An animated demo shows the tool in action and makes the README more engaging for first-time visitors.

The GIF is only 165KB — smaller than many badge images.

Recorded with VHS. Demo hosted on AgentGIF.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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