Help us improve
Share bugs, ideas, or general feedback.
From grimoire
Guides creation of effective READMEs that turn visitors into contributors or users. Covers structure, badges, quick-start, configuration docs, and common mistakes.
npx claudepluginhub jeffreytse/grimoire --plugin grimoireHow this skill is triggered — by the user, by Claude, or both
Slash command
/grimoire:write-readmeThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Write a README that turns a visitor into a contributor or user in under five minutes.
Generates a README.md template for your project with customizable sections. Useful for starting new projects or improving existing documentation.
Generates human-focused README files for projects. Activates on 'write README', 'create README', 'update README'.
Provides README.md templates and standards for generating, improving, or checking project documentation compliance. Activates on README creation, audits, or best practices mentions.
Share bugs, ideas, or general feedback.
Write a README that turns a visitor into a contributor or user in under five minutes.
Adopted by: GitHub community standards checklist; required by npm, PyPI, and crates.io for package discoverability
Impact: Projects with complete READMEs receive 2-3x more stars and contributions on GitHub (GitHub Octoverse report); npm packages with detailed READMEs show higher install counts in equivalent categories
A README is the storefront for your project. Most visitors decide whether to use or contribute within 30 seconds. Clear purpose, instant setup, and visible build status eliminate the friction that causes capable people to close the tab.
Weak opening: "This is a tool I built."
Strong opening: rtk — a token-optimized CLI proxy for Claude Code that reduces API costs by 60-90% by filtering verbose command output before it reaches the model context.