Skip to content

docs: replace README demo GIF placeholder (#30) - #40

Merged
roshanlam merged 5 commits into
mainfrom
docs/demo-gif-30
Sep 30, 2026
Merged

roshanlam merged 5 commits into
mainfrom
docs/demo-gif-30

Conversation

@roshanlam

Copy link
Copy Markdown
Owner

Summary

Closes #30.

Replaces the README "Demo GIF coming soon" placeholder with a real ≤20s demo on the First successful run path:

  • auth-ready run (session already trusted)
  • .key package expand to a usable directory
  • unchanged re-run via the metadata fast path (0 bytes)

Caption 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:

  1. docs/demo/fixture_run.py drives the real DownloadManager package-expand + metadata fast-path code against in-process stream nodes (same contracts as tests/test_package_download.py).
  2. Terminal output from that run was rendered to docs/assets/ifetch-demo.gif (Pillow frames of the CLI story).
  3. docs/demo/demo.tape is also included so a vhs re-record is possible when ttyd/chrome are available.

Review

Sam: please review in chat. Roshan merges.

Test plan

  • Open README on the PR branch — GIF loads under First successful run
  • Confirm placeholder text is gone from the top of README
  • Confirm caption has no ADP/Photos wording
  • Optional: python docs/demo/fixture_run.py reproduces the CLI story locally

Jordan Hale 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).
@roshanlam
roshanlam merged commit 6b5227a into main Sep 30, 2026
11 checks passed
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.

Replace README demo GIF placeholder with real demo

1 participant