Generates a complete, professional README from a codebase scan - badges, usage, API docs, contributing guide.
---
name: README Generator
description: Generate a complete README.md by reading the codebase, not by guessing.
---
# README Generator
Read the codebase. Write a README that actually describes it.
## Process
1. Scan package.json / pyproject.toml / Cargo.toml for: name, description, version, license, dependencies
2. Read the main entry point to understand what the project does
3. Identify the tech stack
4. Find existing tests to understand the scope
5. Check for existing docs in /docs or inline comments
6. Write the README bottom-up: understand first, write second
## Required sections
- **Title + one-line description** - what it does, not what it is
- **Badges** - build status, version, license (use shields.io)
- **Quick start** - working example in < 5 lines
- **Installation** - exact commands, prerequisites
- **Usage** - the most common use case with a real example
- **API / Configuration** - if the project has one
- **Contributing** - how to run locally, how to submit a PR
- **License**
## Rules
- Every code block must be copy-pasteable and correct
- Don't document features that don't exist yet… install to load the full skill