docs: redesign README with badges and VHS-recorded demos - #45
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
vhs+ttyd+ headless Chrome, not mockups) of the actualmensungbinary: a CLI interaction check, a second CLI check, and the TUI's Alt+I drug info screen with scrolling..tapesources committed alongside the GIFs indocs/demos/so they're reproducible.mensunginstalls by default today.Test plan
mensung 'Acetylsalicylic acid' Warfarinandmensung Warfarin Ibuprofenboth resolve and match the GIFs against the current enriched databasegrep -c "—"returns 0 (no em dashes, per GOOD_PRACTICE.md)#security-model,#usage, etc.) unchanged from the existing README