Repository navigation
docs: lead the README with a demo GIF that follows the reader's theme, lay features out as a grid, and fold the long privacy and uninstall details - #143
Merged
Conversation
…, lay features out as a grid, and fold the long privacy and uninstall details
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.
What & why
The README opened with static screenshots and long paragraphs. This makes the first screen show the app moving and keeps the details one click away.
<picture>servesassets/demo-dark.gifto readers on GitHub's dark theme.<details>block. Uninstall commands are folded the same way.assets/shot-dashboard.pngandassets/shot-dashboard-dark.pngare no longer referenced from the repo. I left them in place in case something outside links to them; the dark one already showed the old UI.How tested
netscoped --demo --no-store(synthetic traffic), in headless WebKit at 2x, then converted with ffmpeg (1000×625, 12 fps, about 520 KB each).Checklist
make fmt(no diff),make vet,make testall pass — docs and assets only, not run## Unreleasedin CHANGELOG.md if users would notice — n/a, no app change