docs: add animated terminal demo to README#3511
Open
dobestan wants to merge 1 commit intojqlang:masterfrom
Open
docs: add animated terminal demo to README#3511dobestan wants to merge 1 commit intojqlang:masterfrom
dobestan wants to merge 1 commit intojqlang:masterfrom
Conversation
Member
|
I like the idea. Maybe include the vhs script that produced demo.gif so it can be regenerated/updated? |
Contributor
|
The README.md is distributed, but its attached media should be distributed, or not? |
Member
As in |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds an animated terminal demo near the top of the README. The GIF demonstrates:
jq '.'jq '.[].name'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.