readme-generator

Files

---
name: readme-generator
description: Generate comprehensive README files
version: 1.3.0
---

# README Generator

Create professional README files by analyzing your project.

## What It Analyzes

- Package.json / requirements.txt
- Source code structure
- Existing documentation
- Git history
- Test files

## README Sections

1. **Title & Badges**
2. **Description**
3. **Features**
4. **Installation**
5. **Quick Start**
6. **Usage Examples**
7. **Configuration**
8. **API Reference** (if applicable)
9. **Contributing**
10. **License**

## Output Example

```markdown
# Project Name

[![npm version](badge)](link)
[![Build Status](badge)](link)

Brief description of what this project does.

## Features

- Feature 1
- Feature 2

## Installation

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

## Quick Start

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

## Usage

```
readme-gen --output README.md
readme-gen --template minimal
readme-gen --template detailed
```