Skip to content

Overhaul README with hero GIF and repositioned copy - #9

Merged
danielrmay merged 2 commits into
mainfrom
readme-hero
Jun 10, 2026
Merged

danielrmay merged 2 commits into
mainfrom
readme-hero

Conversation

@danielrmay

Copy link
Copy Markdown
Owner

Summary

  • Adds a hero GIF at the top of the README: a 20s simulated Claude-UI conversation (prod-to-dev data tool prompt, clarifying questions, a Write .clarity-protocol/... tool call recording requirements). 739KB, 1600x1120 rendered, displayed at 800px. The generator pipeline is deterministic (byte-identical across runs) and intentionally lives outside this repo; only the artifact is committed.
  • Repositions the copy: the "pushes back" framing is replaced with asking the questions an architect would ask and recording the answers and decisions as markdown in the repo. plugin.json and marketplace.json descriptions updated to match (versions untouched).
  • Drops the long quoted text demo; the GIF is labeled as a simulation and EXAMPLE.md is linked as the real abridged transcript.
  • Compacts install: the two /plugin commands, one sentence of requirements, Windows notes collapsed into a <details> block (content preserved from Windows compat pass: utf-8 everywhere, hardened guards, windows-latest CI #8).
  • Trims the protocol tree to the load-bearing entries and moves the port/attribution paragraph into an About section near the end, substance intact.

Test plan

  • .venv/bin/pytest tests/ -q: 261 passed
  • python3 scripts/upstream_audit.py: passed (README is not in the watch set)
  • claude plugin validate .: passed
  • GIF inspected frame-by-frame for palette banding and loop seam; two full renders produced identical md5
  • Worth an eyeball on GitHub's rendered README to confirm the embed animates at the right width

- Add a simulated-conversation hero GIF at the top (assets/hero.gif);
  the generator pipeline lives outside this repo
- Reposition from "pushes back" to asking the questions an architect
  would ask and recording decisions in the repo; plugin.json and
  marketplace.json descriptions updated to match
- Drop the long quoted demo in favor of the GIF plus the EXAMPLE.md link
- Compact the install section: two commands, one line of requirements,
  Windows caveats in a collapsed details block
- Trim the protocol tree to the load-bearing entries and move the
  port/attribution paragraph into an About section
Plugins are CLI/desktop/IDE surfaces, not user-installable on web
Claude Code, so the terminal framing advertises where the plugin
actually runs. User prompts type out in the input box and commit to
the transcript; assistant lines stream in.
@danielrmay
danielrmay merged commit f144c12 into main Jun 10, 2026
3 checks passed
@danielrmay
danielrmay deleted the readme-hero branch June 10, 2026 21:26
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.

1 participant