Readme Generation

---
name: readme-generation
description: Create comprehensive, user-friendly README files that help users quickly understand and use a project.
category: docs
triggers:
  - readme
  - documentation
  - onboarding
  - usage
version: 0.2.1
---

# README Generation Skill

## Purpose
Create comprehensive, user-friendly README files that help users quickly understand and use a project.

## README Structure

### 1. Header
- Project name and logo (if applicable)
- One-line description
- Badges (build status, version, license)

### 2. Quick Start
- Installation command
- Basic usage example
- Link to documentation

### 3. Features
- Key capabilities (bulleted list)
- What makes this project useful

### 4. Installation
- Prerequisites
- Step-by-step installation
- Configuration options

### 5. Usage
- Common use cases with code examples
- API overview (if applicable)
- Configuration reference

### 6. Contributing
- How to contribute
- Development setup
- Code style guidelines

### 7. License
- License type
- Copyright notice

## Best Practices

1. **Be Concise** - Get to the point quickly
2. **Show, Don't Tell** - Use code examples
3. **Update Regularly** - Keep docs current
4. **Test Examples** - Ensure code snippets work
5. **Consider Audience** - Write for your users' skill level

## Template

```markdown
# Project Name

Brief description of what this project does.

## Quick Start

\`\`\`bash
npm install project-name
\`\`\`

\`\`\`javascript
import { thing } from 'project-name';
thing.doSomething();
\`\`\`

## Features

- Feature one
- Feature two

## License

MIT
```