shield_lock
JinDaGe
← Back to skills
extension
Category: Development & EngineeringNo API key required

Readme Template

README template generator. Standard, awesome-list, minimal, detailed, library, app, API project.

personAuthor: xueyetianyahubclawhub
open_in_newRepositorydownloadDownload package

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