Skip to content

Replace the demo with an SVG animation and cut the SketchyBar docs#3

Merged
pszypowicz merged 3 commits into
mainfrom
demo-animation-and-docs-cleanup
Jul 14, 2026
Merged

Replace the demo with an SVG animation and cut the SketchyBar docs#3
pszypowicz merged 3 commits into
mainfrom
demo-animation-and-docs-cleanup

Conversation

@pszypowicz

Copy link
Copy Markdown
Owner

What's here

Three commits, each droppable on its own:

  1. Replace the demo GIFs with an SVG animation - a single looping SMIL animation (docs/images/how-it-works.svg) shows the story side by side: AirPods connect, both panels get hijacked, the MicGuard panel snaps back with a shield pulse while the unprotected one stays on AirPods. Pure SMIL, no JS, so it animates inside GitHub READMEs and on the docs site. Replaces the four GIF/MP4 files. Used by both README.md and docs/index.md.
  2. Remove the SketchyBar integration docs - all SketchyBar references and examples are gone (integrations page, notifications page, CLI and debugging mentions, README feature bullet, screenshot). The integrations page now only documents the building blocks: the two notifications, the ping-on-start pattern, CLI commands for click handlers, and the pgrep health check.
  3. Drop the screenshots section - the animation carries the demo now. If you'd rather keep the menubar/settings screenshots, drop this commit and they're back.

Notes

  • I verified the animation by rendering frames at 1s / 3s / 5s with headless Chrome: idle, hijack, and diverged outcomes all display as intended. Preview the raw SVG in a browser to see the full loop (10s).
  • Em dashes in the touched markdown files were normalized to plain hyphens in passing.

A single looping SMIL animation shows the hijack side by side: without
MicGuard the input stays on AirPods, with MicGuard it snaps back to the
preferred mic. One small vector file replaces the GIF/MP4 media and
renders in both the README and the docs site.
The step-by-step SketchyBar walkthrough drowned out the actual
integration surface. The integrations page now documents just the
building blocks (notifications, ping-on-start, CLI commands, health
check); building a specific status-bar plugin is left to the reader.
The animated demo covers what the static screenshots showed; the
menubar and settings UI are simple enough to not need a gallery.
@pszypowicz
pszypowicz force-pushed the demo-animation-and-docs-cleanup branch from b6766b8 to 2ed61a1 Compare July 14, 2026 10:46
@pszypowicz
pszypowicz merged commit c006980 into main Jul 14, 2026
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