README Generator Skill

Purpose

Analyzes project structure to generate or update README.md with installation, usage, API docs, and more.

When to Use

• README generation requests

• New project needs README

• Existing README update needed

• Installation, usage documentation requests

Workflow

Step 1: Analyze Project

Project: my-awesome-app Type: Next.js Web Application Language: TypeScript Package Manager: npm Dependencies: React, Next.js, Tailwind CSS Scripts: dev, build, start, test, lint

Step 2: Check Existing README

README Status:

• Exists: [Yes/No]
• Current sections: [list]
• Last modified: [date]

Step 3: Select Sections

AskUserQuestion:

"Select README sections" Options:

• Project intro/overview
• Installation
• Usage/Getting started
• Environment variables
• API documentation
• Contributing guide
• License multiSelect: true

Step 4: Select Style

AskUserQuestion:

"Select README style" Options:

• Concise (essentials only)
• Detailed (screenshots/GIFs)
• Technical (API-focused)
• Open source (badges, contributing)

README Templates

Basic Structure

Project Name

Brief description (1-2 sentences)

Features

• Feature 1
• Feature 2

Installation

```bash git clone https://github.com/username/project.git cd project npm install ```

Usage

```bash npm run dev # Development npm run build # Production build ```

Environment Variables

Create .env.local: ```env DATABASE_URL=your_database_url NEXT_PUBLIC_API_URL=your_api_url ```

Tech Stack

• Framework: Next.js 14
• Language: TypeScript

Project Structure

``` ├── app/ # Next.js App Router ├── components/ # React components ├── lib/ # Utilities └── public/ # Static assets ```

Contributing

1. Fork the repository
2. Create feature branch
3. Commit changes
4. Push to branch
5. Open Pull Request

License

MIT License

Open Source Template

Project Name

Compelling project description

Installation

```bash npm install package-name ```

Usage

```typescript import { feature } from 'package-name' const result = feature({ option: 'value' }) ```

API Reference

feature(options)

Contributing

See CONTRIBUTING.md

License

MIT - see LICENSE

Response Template

README Generated

File: README.md Style: Detailed

Included Sections

• Project intro
• Installation
• Usage
• Environment variables
• Tech stack
• Contributing
• License

Recommendations

• Add screenshots/demo GIF
• Detail API documentation
• Create CONTRIBUTING.md

Best Practices

• Concise: Quick access to key info

• Structured: Clear section separation

• Examples: Copy-paste ready code

• Current: Keep versions updated

• Visual: Badges, screenshots for readability

Integration

• api-documenter skill: API section details

• /explain-code command: Project structure understanding

Notes

• Preserves existing README style when updating

• Excludes sensitive info (.env values)

• Project structure based on actual analysis