Skip to content

docs: add animated terminal demo to README#3511

Open
dobestan wants to merge 1 commit intojqlang:masterfrom
dobestan:add-demo-gif
Open

docs: add animated terminal demo to README#3511
dobestan wants to merge 1 commit intojqlang:masterfrom
dobestan:add-demo-gif

Conversation

@dobestan
Copy link
Copy Markdown

Summary

Adds an animated terminal demo near the top of the README. The GIF demonstrates:

  • Pretty-printing JSON with jq '.'
  • Extracting fields with jq '.[].name'
  • Filtering with jq '.[] | select(.age > 27)'

Why

The README currently has no visual demo. An animated recording lets first-time visitors immediately see what jq does and how intuitive the syntax is — which is jq's biggest selling point.

The GIF is 145KB and stored in media/.

Recorded with VHS. Demo hosted on AgentGIF.

@wader
Copy link
Copy Markdown
Member

wader commented Mar 19, 2026

I like the idea. Maybe include the vhs script that produced demo.gif so it can be regenerated/updated?

@itchyny
Copy link
Copy Markdown
Contributor

itchyny commented Mar 25, 2026

The README.md is distributed, but its attached media should be distributed, or not?

@wader
Copy link
Copy Markdown
Member

wader commented Mar 25, 2026

The README.md is distributed, but its attached media should be distributed, or not?

As in make dist? yes that makes sense. So add to dist_doc_DATA? https://github.com/jqlang/jq/blob/master/Makefile.am#L241

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.

3 participants