Skip to content

Add a reproducible animated README demo - #11

Merged
HoungDev merged 1 commit into
mainfrom
agent/readme-demo
Aug 7, 2026
Merged

HoungDev merged 1 commit into
mainfrom
agent/readme-demo

Conversation

@HoungDev

@HoungDev HoungDev commented Aug 7, 2026

Copy link
Copy Markdown
Owner

What changed

  • add a lightweight animated terminal demo near the top of the README
  • show real title, tag, and non-mutating image rename preview workflows
  • add accessible alt text, a text transcript, concise before/after examples, and a focused Why Creator Toolkit section
  • add a reproducible Pillow renderer that captures current CLI output using disposable sample files
  • include the renderer and demo assets in the source distribution
  • rebuild the demo in the Linux quality job and audit the optional demo dependency

Why

Prospective users can now understand the toolkit's core value within the first screen of the README. Contributors can reproduce the asset from documented commands instead of editing an opaque binary by hand.

Validation

  • ruff check .
  • ruff format --check .
  • pytest --basetemp .test-tmp-readme-demo-suite — 48 passed, 93.79% coverage
  • fresh environment install with .[demo], renderer execution, and pip check
  • deterministic GIF rebuild — 900×506, 3 frames, 44,507 bytes
  • dependency audit — no known vulnerabilities after upgrading the temporary environment's pip toolchain
  • wheel and source distribution build plus twine check
  • source distribution verified for the GIF, transcript, and renderer
  • workflow YAML parse, README local-link/alt-text checks, and personal-path scan

Closes #6

@HoungDev
HoungDev marked this pull request as ready for review August 7, 2026 07:53
@HoungDev
HoungDev merged commit 1ef78a3 into main Aug 7, 2026
7 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.

Add an animated README demo and real workflows

1 participant