| name | readme-generator |
| description | Creates comprehensive README files with templates for different project types. Use when creating README, project documentation, or getting started guides. |
README Generator
Quick Start
Generate a README based on project type:
ls package.json && echo "Node.js project" || \
ls setup.py pyproject.toml && echo "Python project" || \
ls go.mod && echo "Go project"
Instructions
Step 1: Analyze Project
Gather project information:
- Project name (from package.json, pyproject.toml, etc.)
- Description (from manifest or git)
- Main language and framework
- Key features (scan source files)
- Dependencies (from manifest files)
Step 2: Select Template
Choose template based on project type:
| Type | Template | Key Sections |
|---|
| Library | library | Installation, API, Examples |
| CLI Tool | cli | Installation, Commands, Options |
| Web App | webapp | Features, Setup, Deployment |
| API | api | Endpoints, Authentication, Examples |
Step 3: Generate Core Sections
Title and Description:
# Project Name
Brief one-line description of what the project does.
[](LICENSE)
[](package.json)
Installation:
## Installation
\`\`\`bash
npm install project-name
# or
pip install project-name
\`\`\`
Usage:
## Usage
\`\`\`javascript
const project = require('project-name');
// Basic example
project.doSomething();
\`\`\`
Step 4: Add Project-Specific Content
Include relevant sections:
- Features: Bullet list of key capabilities
- API Reference: For libraries
- Configuration: For configurable tools
- Examples: Real-world use cases
- Contributing: How to contribute
- License: License information
Step 5: Add Badges and Links
Common badges:
README Structure
Essential Sections (all projects)
- Title and Description
- Installation
- Quick Start / Usage
- License
Recommended Sections
- Features - What makes it useful
- Documentation - Link to full docs
- Examples - Common use cases
- Contributing - How to help
- Support - Where to get help
Optional Sections
- Requirements - System dependencies
- Configuration - Setup options
- Troubleshooting - Common issues
- Changelog - Recent changes
- Acknowledgments - Credits
Advanced
For detailed information, see:
