TheMagicREADME
generate · customize · ship docs faster
A CLI tool to generate README files magically. Ten templates, interactive prompts, and sensible defaults — a GitHub-ready README in under a minute.
npm install -g the-magic-readmeWhy it exists
A README you'll actually finish
Writing a good README is the part of shipping nobody enjoys. The Magic README turns it into a guided conversation.
Interactive prompts
A guided four-step flow in your terminal — no flags to memorize, no config to hand-edit.
10 built-in templates
Classic, minimal, modern, production, and specialty layouts covering every kind of project.
Custom templates
Save your own Markdown recipes with {{placeholders}} and reuse them forever.
Sensible defaults
Every prompt ships a neutral default — press Enter and keep moving.
Preview before write
See the finished Markdown and an explicit overwrite warning before anything touches disk.
GitHub-ready Markdown
Badges, hero images, tables, and TOCs — output that looks right straight out of the box.
How it works
Three moves, done
- 01
Install once
One npm command puts the-magic-readme on your PATH — no setup files, no plugins.
- 02
Run it
The interactive flow starts in your terminal. Every prompt has a sensible default — Enter accepts it.
- 03
Pick a template & confirm
Preview the rendered Markdown, confirm, and the file lands in your project directory.
Templates
Ten layouts, one command
Each template is a full, opinionated Markdown layout. Pick one in step 2 and the prompts fill it in.
Classic
Bold centered hero, badges, and a clean contact block.
classic
Classic Stats
Social proof style README with stars, forks, and quick links.
classic-stats
Minimal
Ultra-clean one-pager for small tools and scripts.
minimal
Modern
Feature-rich open-source README with TOC and structure.
modern
Production
Ops-ready docs: config, scripts, security, troubleshooting.
production
CLI Tool
Terminal-first template for npm CLIs and developer tools.
cli
Library / SDK
Package README with install, API table, and examples.
library
SaaS Product
Product-style README for startups and web apps.
saas
Open Source
Contributor-friendly community README with mission and COC.
opensource
Supabase
Auth, RLS, storage, and edge-function oriented README.
supabase
Your own template
Save any Markdown recipe with{{placeholders}}and reuse it forever.
Learn how →
Quick start
From nothing to README in under a minute
No config files, no flags. Just run it and answer the prompts — or accept every default.
- 1
Install it. Run npm install -g the-magic-readme once — the command is then global.
- 2
Run it in your project. Open the folder that should hold the README and run the-magic-readme.
- 3
Pick a template, accept defaults. Choose a layout; every prompt shows a default you accept with Enter.
- 4
Confirm the preview. Review the rendered Markdown, confirm, and the file is written.
$ the-magic-readme
? Choose an action Generate a README
? Pick a template (10 templates available)
❯ classic
? Author name (Your Name) Jane Dev
? Repository name (your-project) acme-widget
? Repository URL (https://github.com/username/your-project)
? Logo URL (https://placehold.co/96x96/png?text=Logo)
? Email ([email protected])
? LinkedIn (your-linkedin)
? File name (classic.md)
? Preview looks good — write classic.md? (y/N) y
✔ classic.md created from "Classic"Stop writing READMEs by hand.
One command, a few prompts, and your project ships with a README that looks like you spent an afternoon on it.
npm install -g the-magic-readme