Docs: animated SVG demo in README (v0.8.2)#21
Merged
Conversation
Adds assets/demo.svg — a self-contained animated terminal cast
(~11 KB) showing the three-step flow against the Common Paper
Mutual NDA cover page fixture in examples/:
1. draft --version
2. draft --list-placeholders examples/cp-mutual-nda-coverpage.md
3. draft examples/cp-mutual-nda-coverpage.md \
--purpose ... --effective-date ... --term ... \
--governing-state ... --jurisdiction ... --diff
Generated via:
1. asciinema 3.2.0 records the script in headless mode
2. v3 cast → v2 cast conversion script
3. svg-term-cli renders to a self-contained animated SVG with
the standard terminal-window chrome
Embedded between the intro paragraph and "Run this" section,
matching nda-review-cli's placement of its asciinema cast.
Self-contained means no asciinema.org hosting dependency — the
SVG plays inline on github.com and npmjs.com (which both pull
images from the GitHub raw URL when assets/ isn't shipped in the
npm package).
Strictly docs + assets; no code or test changes.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Summary
Adds an animated SVG demo to the README, embedded between the intro paragraph and the "Run this" section. Matches nda-review-cli's pattern of placing the cast immediately before the first command. Self-contained: ~11 KB SVG, plays inline on github.com and npmjs.com without an asciinema.org dependency.
What's in the cast
7.7-second loop showing the three-step flow against the Common Paper Mutual NDA fixture in
examples/:draft --versiondraft --list-placeholders examples/cp-mutual-nda-coverpage.mddraft examples/cp-mutual-nda-coverpage.md --purpose ... --diffHow it was generated
npx svg-term-clirenders to a self-contained animated SVG with standard terminal-window chromeTest plan
npm test— no test changes🤖 Generated with Claude Code