README Generator

Generate comprehensive README files by analyzing your codebase. Creates sections for installation, usage, API reference, configuration, contributing guidelines, and badges from your actual code and package config.

This skill inspects your project structure, package.json, source code, and tests to generate an accurate README. It creates proper installation instructions, detects CLI commands and API surfaces, generates usage examples, and adds relevant badges for CI, coverage, and package versions.

When to use

Use when starting a new project, open-sourcing internal code, updating outdated READMEs, or ensuring your documentation accurately reflects the current state of the codebase.

Examples

Generate from codebase

Create a README by analyzing the project

Analyze this project and generate a comprehensive README with installation, usage, API docs, and contributing guidelines

Open source README

Create a README optimized for open source contributions

Create a README for open-sourcing this project — include badges, license, code of conduct, and clear contribution steps