Skip to content

docs: redesign README with recordings, install script, harness comparison - #53

Merged
danielkov merged 8 commits into
mainfrom
docs/readme-redesign
Aug 29, 2026
Merged

docs: redesign README with recordings, install script, harness comparison#53
danielkov merged 8 commits into
mainfrom
docs/readme-redesign

Conversation

@danielkov

Copy link
Copy Markdown
Contributor

Promotional README rewrite plus supporting assets.

  • README: hero GIF, one-tool pitch, install (script / mise / docker / source), quick start, feature tour with recordings, config sample, harness comparison, limits, docs index. Removed "hidden tool" wording.
  • docs/media/: vhs recordings of the TUI (fix-tests hero, live compose source, Claude+Codex subagents, background compose, MCP tool_search, headless prompt/resume) and model-picker / sessions screenshots. Tapes in scripts/readme-media/ for re-recording.
  • install.sh: POSIX installer that resolves the latest release, verifies against SHA256SUMS, installs to ~/.local/bin (macOS arm64, Linux x86-64).
  • docs/harness-comparison.md + scripts/harness-comparison/: Kit vs Codex CLI vs Claude Code from local transcripts, with caveats.
  • Remaining media are HTML-comment placeholders in the README with recording instructions (install GIF, steering, plugins, long-session gauge, OTel trace, editor over ACP).

@danielkov
danielkov merged commit 4bad70e into main Aug 29, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant