Skip to content

docs: add an animated demo to the README #50

@ryanlewis

Description

@ryanlewis

The README opening (#49) now spells out capabilities with examples, but a short animated demo would land it harder — show things actually being used in a terminal.

Approach

  1. Record a short session with asciinema rec docs/demo.cast against the real Things DB (todayaddeditcompletesearchopen).
  2. Redact personal data by editing the .cast file directly — it's just JSON frames ([timestamp, "o", "text"]), so real task titles / project names / tags can be swapped for demo strings inline. Keep replacement string lengths close to the originals so cursor positions don't drift.
  3. Render with agg docs/demo.cast docs/demo.gif (or keep the cast and embed via asciinema player).
  4. Wire docs/demo.gif into the README, just under the lede and above the examples block.

Open questions

  • GIF vs. embedded asciinema player vs. SVG (svg-term-cli)?
  • Should we commit a docs/RECORDING.md with the exact commands so re-recording on a CLI surface change is one command?
  • Is it worth scripting the redaction (e.g. a small jq / Go tool that takes a mapping file) so future re-records are mechanical?

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions