# README Template

> README template generator. Standard, awesome-list, minimal, detailed, library, app, API project, and badge generators. Markdown output with best practices. readme, markdown, documentation, open-source, project-setup, developer-tools.

- Skill: `dvcrn/readme-template` (Agent Skill, multi-file: 4 files)
- Install (CLI): `npx skillmds@latest add dvcrn/readme-template`
- Raw SKILL.md: https://api.skillmd.com/api/skills/dvcrn/readme-template/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: dvcrn (https://skillmd.com/u/dvcrn)
- Updated: 2026-09-08
- Page: https://skillmd.com/skills/dvcrn/readme-template

---


# 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` | 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) |

## Usage

```bash
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.