better-readme
Audit, generate, and optimize project README files with 8-dimension quality scoring (0–100), 5-type template matching, and pre-publish readiness checks.
Why this is useful: Most README files are written as an afterthought. This skill scores them across 8 dimensions (first impression, problem statement, quick start, visual demo, feature clarity, API docs, badges, community), recommends a template based on project type, and generates a production-ready README.
Key Features
- 0–100 scoring across 8 dimensions — the only README auditor on ClawHub with quantitative scoring
- 5 project types: Library/SDK, CLI Tool, App/Product, Agent Skill, Data/Resource
- Auto-detection: scans
package.json, pyproject.toml, etc. to classify project type
- Pre-publish checklist: critical/important/nice-to-have GitHub launch items
- Onboarding: first run offers to audit all your existing repos' READMEs
- Bilingual support: English by default, opt-in for other languages
Links
Compatibility
- OpenClaw, Claude Code, Cursor, Codex CLI, Gemini CLI
- Python 3.8+ (audit script only, no other dependencies)
License
MIT
better-readme
Audit, generate, and optimize project README files with 8-dimension quality scoring (0–100), 5-type template matching, and pre-publish readiness checks.
Why this is useful: Most README files are written as an afterthought. This skill scores them across 8 dimensions (first impression, problem statement, quick start, visual demo, feature clarity, API docs, badges, community), recommends a template based on project type, and generates a production-ready README.
Key Features
package.json,pyproject.toml, etc. to classify project typeLinks
clawhub install better-readmeCompatibility
License
MIT