docs: replace README demo GIF placeholder (#30) - #40
Merged
Merged
Conversation
added 5 commits
September 29, 2026 23:14
Remove the placeholder and embed docs/assets/ifetch-demo.gif on the First successful run path.
Pillow-rendered terminal recording of docs/demo/fixture_run.py output (auth-ready, .key expand, fast-path re-run).
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
Closes #30.
Replaces the README "Demo GIF coming soon" placeholder with a real ≤20s demo on the First successful run path:
.keypackage expand to a usable directoryCaption notes the existing 2.8 GiB / 4.4s / 0 bytes benchmark. No ADP or Photos claims.
How the GIF was produced
Honest fixture-backed path — no live Apple ID:
docs/demo/fixture_run.pydrives the realDownloadManagerpackage-expand + metadata fast-path code against in-process stream nodes (same contracts astests/test_package_download.py).docs/assets/ifetch-demo.gif(Pillow frames of the CLI story).docs/demo/demo.tapeis also included so a vhs re-record is possible when ttyd/chrome are available.Review
Sam: please review in chat. Roshan merges.
Test plan
python docs/demo/fixture_run.pyreproduces the CLI story locally