Readme Template
by @xueyetianya
README template generator. Standard, awesome-list, minimal, detailed, library, app, API project.
clawhub install readme-templateπ About This Skill
version: "2.0.0" name: README Template description: "README template generator. Standard, awesome-list, minimal, detailed, library, app, API project." author: BytesAgain homepage: https://bytesagain.com source: https://github.com/bytesagain/ai-skills
README Template β Professional README Generator
Pick a style, get a polished README. Every project deserves one.
Available Templates
| Command | Style | Best For |
|---------|-------|----------|
| standard | Balanced sections | Most projects |
| awesome | Awesome-list format | Curated resource lists |
| minimal | Bare essentials | Small scripts/tools |
| detailed | complete | 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) |
Usage
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"
Output
All templates output valid Markdown, ready to save as README.md.
Includes placeholder sections β fill in your details and ship.
π¬ Feedback & Feature Requests: https://bytesagain.com/feedback Powered by BytesAgain | bytesagain.com
π‘ Examples
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"