README Template

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

Lord1Egypt Updated 2 repo stars

File contents

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

Lord1Egypt/awesome-skill-forge/tree/main/community/clawhub/r/readme-template commit f8e4dba745

Frequently asked questions

npx skillmds@latest add lord1egypt/readme-template