README Generator
Build beautiful README.md files with a visual editor — then copy or download.
📌Heading
💬Quote
🏷️Badges
LabelValueColor
📝Paragraph
📌Heading
📋List
•
•
•
📌Heading
📋List
•
•
•
📌Heading
💻Code Block
📌Heading
📝Paragraph
💻Code Block
📌Heading
📝Paragraph
About README Generator
Create professional README.md files for your GitHub projects instantly. Fill in sections like badges, features, installation, usage, and more using a visual form editor. Preview the rendered result, then copy the markdown or download the file.
How to Use
- 1Fill in your project details in the Editor tab — at minimum a project name.
- 2Toggle optional sections (Badges, Demo, Features, Installation, etc.) ON or OFF.
- 3Switch to the Preview tab to see how your README will look on GitHub.
- 4Use the Raw tab to inspect the full markdown source.
- 5Click "Copy Markdown" to copy to clipboard, or "Download README.md" to save the file.
Frequently Asked Questions
Can I download the generated README?
Yes. Click the "Download README.md" button to save the file directly to your computer.
Are badges automatically generated?
Yes. Badges are created using shields.io. Just enter a label, value, and color and the badge URL is generated for you.
Can I toggle sections on or off?
Yes. Every optional section has an ON/OFF toggle. Only enabled sections appear in the generated markdown.
Does the preview render actual markdown?
The Preview tab shows a rendered HTML representation of your README, similar to how GitHub displays it.
Is my data saved anywhere?
No. All data stays in your browser. Nothing is sent to a server.
Tool Info
- Category
- dev
- Usage
- Unlimited
Related Tools
More dev tools
JSON Formatter
Format, validate, and beautify JSON data.
Base64 Encode/Decode
Encode text to Base64 or decode Base64 to text.
Encoder / Decoder
Encode & decode text with 15+ formats: Base64, URL, Hex, Binary, Morse, ROT13, JWT, SHA-256 and more.
GitHub Repository Scanner
Visualize any public GitHub repo: file tree, stats, README, and contributors.