This skill should be used when the user asks to "create a README", "write a README", "generate a README", "improve my README", "make my README better", "README best practices", or mentions needing project documentation. Provides guidance for creating excellent READMEs following patterns from awesome-readme.
/plugin marketplace add tavva/ben-claude-plugins/plugin install readme-generator@ben-claude-pluginsThis skill inherits all available tools. When active, it can use any tool Claude has access to.
references/patterns.mdGenerate excellent README files that communicate project value clearly and help users get started quickly.
Great READMEs answer three questions immediately:
Analyse the project to understand:
Read existing code, configuration files, and any existing documentation to extract accurate information.
Start with a clear, descriptive title. Follow with a one-paragraph description that explains:
# Project Name
Brief description of what this project does and why it exists.
A sentence about the key benefit or problem it solves.
Add visual elements that communicate quickly:
Place badges immediately after the title. Place screenshots/GIFs after the description.
Provide the fastest path to a working example:
## Quick Start
\`\`\`bash
npm install project-name
\`\`\`
\`\`\`javascript
import { thing } from 'project-name';
thing.doSomething();
\`\`\`
Keep quick start under 5 steps. Link to detailed installation for complex setups.
Cover all supported installation methods:
Include version compatibility information where relevant.
Show real, practical examples:
## Usage
### Basic Example
\`\`\`javascript
// Description of what this does
const result = doThing(input);
console.log(result);
// Output: expected output
\`\`\`
### Advanced Configuration
\`\`\`javascript
// More complex example with options
\`\`\`
Document public interfaces:
For extensive APIs, link to separate documentation rather than bloating the README.
Include or link to contribution guidelines:
State the licence clearly. Link to the full LICENCE file.
## Licence
MIT - see [LICENCE](LICENCE) for details.
Recommended order for most projects:
Before finalising a README:
For detailed patterns, badge examples, and templates:
references/patterns.md - Comprehensive patterns, badge snippets, and structural templatesCreate employment contracts, offer letters, and HR policy documents following legal best practices. Use when drafting employment agreements, creating HR policies, or standardizing employment documentation.
Implement GDPR-compliant data handling with consent management, data subject rights, and privacy by design. Use when building systems that process EU personal data, implementing privacy controls, or conducting GDPR compliance reviews.