Skip to content

docs(readme): rewrite for ready-for-use framing, drop PLAN.md - #7

Merged
joemckenney merged 1 commit into
mainfrom
joe/readme-ready-for-use
May 13, 2026
Merged

joemckenney merged 1 commit into
mainfrom
joe/readme-ready-for-use

Conversation

@joemckenney

Copy link
Copy Markdown
Owner

Summary

  • Rewrite README in wake-style voice matching cgroup-mcp: Installation first, brief setup, three concrete usage examples drawn from real motivating cases, tools table, How It Works diagram, Releases section
  • Drop "Early development" framing; the actual state is three tools shipped + working install pipeline
  • Delete PLAN.md (it's preserved in git history; not part of the user-facing surface anymore)

Diff shape

2 files changed, 66 insertions(+), 200 deletions(-)
 delete mode 100644 PLAN.md

Test plan

  • No em-dashes
  • cargo build clean (only docs changed)
  • Eyeball the rendered README on the PR page

🤖 Generated with Claude Code

Restructure the README in the same wake-style voice as cgroup-mcp:
Installation first as the primary CTA, brief setup, usage examples
drawn from real motivating cases (the session-1.scope drill-down,
the cgroup_prefix subtree scoping, the process_info bundle), tools
table, How It Works with a small ASCII diagram, and Releases at
the bottom. Drops the "Early development" framing in favor of a
tone that matches the actual state (three tools shipped, install
script works, releases auto-flow).

PLAN.md served its purpose during the design phase. It's preserved
in git history; removing it from the repo so the surface is just
what users need.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@joemckenney
joemckenney merged commit 1bdf28b into main May 13, 2026
1 check 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