Skip to content

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
doldoldol21 merged 1 commit into
mainfrom
docs/readme-refresh
Nov 17, 2026
Merged

doldoldol21 merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@doldoldol21

Copy link
Copy Markdown
Owner

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.

  • Top: a 12 s demo GIF of the dashboard (live chart, domain filter, chart tooltip) in place of the static dashboard screenshot. <picture> serves assets/demo-dark.gif to readers on GitHub's dark theme.
  • A link row under the badges: Install · Features · How it works · Privacy · Develop.
  • Features: the bullet list becomes a two-column grid. Wording is unchanged.
  • Privacy: the "two things do go out" part (reverse DNS, update checks, daemon flags) is folded into a <details> block. Uninstall commands are folded the same way.

assets/shot-dashboard.png and assets/shot-dashboard-dark.png are 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

  • GIFs recorded from the current web UI against netscoped --demo --no-store (synthetic traffic), in headless WebKit at 2x, then converted with ffmpeg (1000×625, 12 fps, about 520 KB each).
  • README rendering on GitHub not yet checked — please look at the branch page in light and dark themes before merging.

Checklist

  • make fmt (no diff), make vet, make test all pass — docs and assets only, not run
  • Added/updated tests for behavior changes — n/a
  • Updated README / flags if user-facing behavior changed
  • Added a line under ## Unreleased in CHANGELOG.md if users would notice — n/a, no app change
  • One focused change; commit messages follow the convention

…, lay features out as a grid, and fold the long privacy and uninstall details
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 17, 2026
@doldoldol21
doldoldol21 merged commit a2d6bd5 into main Nov 17, 2026
9 checks passed
@doldoldol21
doldoldol21 deleted the docs/readme-refresh branch November 17, 2026 05:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant