README template generator. Standard, awesome-list, minimal, detailed, library, app, API project, and badge generators. Markdown output with best practices. r...
Pick a style, get a polished README. Every project deserves one.
| Command | Style | Best For |
|---|---|---|
standard | Balanced sections | Most projects |
awesome | Awesome-list format | Curated resource lists |
minimal | Bare essentials | Small scripts/tools |
detailed | Comprehensive | Enterprise / complex projects |
library | API-focused | npm/pip packages |
app | User-facing | Desktop/mobile/web apps |
api | Endpoint-centric | REST/GraphQL services |
badges | Shield.io badges | Any project (add-on) |
bash scripts/readme-template.sh standard myproject
bash scripts/readme-template.sh minimal mytool
bash scripts/readme-template.sh badges myproject npm
bash scripts/readme-template.sh awesome "DevOps Tools"
All templates output valid Markdown, ready to save as README.md.
Includes placeholder sections — fill in your details and ship.
ZIP package — ready to use