Skip to content

docs: redesign README with badges and VHS-recorded demos - #45

Merged
Etoile-Bleu merged 1 commit into
mainfrom
readme-badges-demos
Jul 16, 2026
Merged

docs: redesign README with badges and VHS-recorded demos#45
Etoile-Bleu merged 1 commit into
mainfrom
readme-badges-demos

Conversation

@Etoile-Bleu

Copy link
Copy Markdown
Owner

Summary

  • Applies the same visual treatment ZamSync's README already uses: a badge row (CI, release, license, platforms, dev.to article link), a hero GIF right under the disclaimer, and a features table. Sections that don't apply to MenSung (Docker, PKI, Prometheus, sponsors) were left out rather than copied blindly.
  • Three real terminal recordings (vhs + ttyd + headless Chrome, not mockups) of the actual mensung binary: a CLI interaction check, a second CLI check, and the TUI's Alt+I drug info screen with scrolling. .tape sources committed alongside the GIFs in docs/demos/ so they're reproducible.
  • Fixes a real accuracy bug found while recording these: the enriched dataset's exact INN name is "Acetylsalicylic acid", not "Aspirin", so the README's old example would return "Unknown drug" against the database mensung installs by default today.

Test plan

  • Verified mensung 'Acetylsalicylic acid' Warfarin and mensung Warfarin Ibuprofen both resolve and match the GIFs against the current enriched database
  • grep -c "—" returns 0 (no em dashes, per GOOD_PRACTICE.md)
  • All internal doc links (#security-model, #usage, etc.) unchanged from the existing README

Applies the same visual treatment ZamSync's README uses: a badge row
(CI, release, license, platforms, dev.to article), a hero GIF right
under the disclaimer, and a features table. Demos are real recordings
(vhs + ttyd + headless Chrome) of the actual binary, not mockups, with
their .tape sources committed alongside so they're reproducible.

Also fixes the CLI example: the enriched dataset's exact INN name is
"Acetylsalicylic acid", not "Aspirin", so the old example would have
returned "Unknown drug" against the database mensung installs by
default today.
@Etoile-Bleu
Etoile-Bleu merged commit b6cf1ed into main Jul 16, 2026
6 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.

1 participant