Rewrite the README and add a recorded demo

Browse Source

Rework the README into the house style: badges, a one-line pitch, an
anchor nav, a commands table, and dedicated sections for clone, pack, and
the native viewer. Every flag and default is checked against the current
binary so the docs match what kage actually does.

Add a demo recorded with ascii-gif. The tape clones example.com, packs it
to a ZIM and to a self-contained binary, and serves it back offline, so
the whole loop reads in one frame. It sits at the top of the README and on
the docs home.

While reviewing the docs, fix the output path everywhere: the default is
$HOME/data/kage, not the kage-out the pages claimed, including a few
fabricated 'done kage-out/...' lines. Document pack, open, and the native
viewer in the release notes.

...

This commit is contained in:

Duc-Tam Nguyen

2026-06-14 22:25:31 +07:00

parent 5b7f7d9f31

commit 3af26ae0e5

11 changed files with 209 additions and 95 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

docs/static/demo.gif

Vendored

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 169 KiB