docs: add quickstart demo GIF to README hero - #29
Open
brainsparker wants to merge 1 commit into
Open
Conversation
Owner
Author
|
Triage note: leaving this open rather than merging. The branch only adds the image reference; assets/quickstart.gif still needs the manual web UI upload described above, and merging now would ship a broken image in the README hero. Also worth re-checking that the re-rendered GIF shows the scoped install command (npm install -g @brainsparker/you-md) now that #30 is on main. Ready to merge as soon as the GIF is on the branch. |
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
1 participant
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.
Why
The README describes the quickstart but never shows it. A 30-second animated terminal demo directly under the tagline converts a skim into an install far better than prose.
What changed
The placement is above the intro paragraph on purpose: it avoids touching the section edited by #27, so both PRs merge cleanly in either order.
Manual step: upload the GIF
The GitHub App used here cannot commit binary files, so the GIF needs a web UI upload to this branch before merging: Add file, Upload files, into assets/, named quickstart.gif. The file is attached in the review thread.
About the demo
The recording is built from real CLI output: init, validate, skill install (detecting Claude Code and Cursor), and skill status showing both active. 840x560, 227 KB, loops. Commands are shown as npx you-md, matching the README's published-package state, so this lands best alongside the first npm release.