docs: rewrite README with CLI profile and benchmark verification - #13
Merged
Conversation
Align README structure with the CLI profile: clear hook positioning, terminal execution demo citing evidence, verified multi-package install instructions with collapsible options, categorized 37-language support matrix, and structured FAQ.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Restructures
README.mdto follow the measured CLI tool profile and pass empirical scoring criteria:shares config, file, parse).@systemfsoftware/claude-code-comment-checker(npm/pnpm/yarn/bun) with optionalDependencies prebuilts as primary; collapses Cargo and GitHub release downloads into expandable details.0= Pass,2= Block), custom--promptformatting, and common troubleshooting questions.Validation
write-readme-mdbenchmark (score_readme.tspassing all confirmed structural gates with prose density > 5.0 words/line).LICENSE,AGENTS.md,.github/workflows/ci.yml, anddocs/plans/2026-08-17-001-feat-npm-distribution-release-plan.md.