📝 Readme
When the user wants to create or update a README.md file for a project. Also use when the user says "write readme," "create readme," "document this project," "project documentation," or asks for help with README.md. This skill creates absurdly thorough documentation covering local setup, architectur
npx playbooks add skill shpigford/skills --skill readme
About Readme
Readme is a free documentation skill that configures AI coding agents to when the user wants to create or update a readme.md file for a project. also use when the user says "write readme," "create readme," "document this project," "project documentation," or asks for help with readme.md. this skill creates absurdly thorough documentation covering local setup, architectur.
Its 45-word system prompt specializes your agent in documentation with structured methodology and proven output formats. Install with one command to activate immediately.
Use Cases
- Writing API references and README files
- Generating inline code comments and docstrings
- Creating architecture decision records (ADRs)
- Keeping docs in sync with code changes
Example Prompts
System Prompt (45 words)
When the user wants to create or update a README.md file for a project. Also use when the user says "write readme," "create readme," "document this project," "project documentation," or asks for help with README.md. This skill creates absurdly thorough documentation covering local setup, architectur
Frequently Asked Questions
What is Readme?
Readme is a free documentation skill for AI coding agents. When the user wants to create or update a README.md file for a project. Also use when the user says "write readme," "create readme," "document this project," "project documentation," or asks for help with README.md. This skill creates absurdly thorough documentation covering local setup, architectur. It provides a specialized system prompt that configures your agent with documentation expertise.
How do I use Readme with Claude Code?
Run npx playbooks add skill shpigford/skills --skill readme in your terminal to install Readme into your Claude Code session. It works immediately after installation.
Which AI coding agents work with Readme?
Readme is compatible with Claude Code, Cursor, GitHub Copilot, Windsurf, OpenClaw, Cline, and any AI agent that supports custom system prompts or .cursorrules files.
Is Readme free to use?
Yes, Readme is completely free and open source. The full source is available on GitHub at https://github.com/shpigford/skills/tree/main/readme. You only need a subscription to the AI agent you use it with.
