Skip to content

Revamp README hero section and add usage decision-aid - #11

Merged
amanjaiman merged 6 commits into
mainfrom
docs/readme-revamp
Jul 4, 2026
Merged

Revamp README hero section and add usage decision-aid#11
amanjaiman merged 6 commits into
mainfrom
docs/readme-revamp

Conversation

@amanjaiman

Copy link
Copy Markdown
Owner

Summary

  • Replace the top of the README with a centered hero (title, badges, punchier tagline) instead of the plain markdown badge row + literal feature sentence
  • Add a "Ways to use it" section mapping run / run --daemon / run --watch-only / attach-existing to when you'd reach for each, as a lightweight decision aid ahead of the reference tables
  • Inspired by kunchenguid/no-mistakes' README structure; no functional/code changes

Test plan

  • Verified badge URLs/targets are unchanged, just re-marked-up as HTML
  • Verified new "Ways to use it" section only restates facts already documented elsewhere in the README (no invented flags/behavior)
  • Reviewer: preview the rendered README on GitHub to confirm the centered hero renders as expected

🤖 Generated with Claude Code

amanjaiman and others added 6 commits July 3, 2026 23:50
Centered header/badges and a punchier tagline make the project easier
to scan at a glance, and a "Ways to use it" section maps run modes to
when you'd reach for each, inspired by kunchenguid/no-mistakes' README.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
These flags are being removed in a follow-up PR (dead/low-value per
feature audit: --daemon adds little over leaving the terminal open on
the pty backend and isn't reattachable on crash there; --watch-only
undercuts the core auto-resume pitch and has no test coverage).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Being removed in the companion feature-removal PR: opt-out of the
core auto-detach-on-attach behavior, with no test coverage or clear
use case. Auto-detach is now always on.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Reflects --auto-answer-prompts defaulting to on (merged in #13),
matching the same factual (not alarmist) framing used in the CLI
help text and CHANGELOG.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@amanjaiman
amanjaiman merged commit 46c39fa into main Jul 4, 2026
3 of 4 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