Online Tool Store
README Generator
Fill in a simple form and generate a complete README.md with badges, features, installation and usage instructions, license, and author section. Runs entirely in your browser.
🔒 This tool runs entirely in your browser. Your files are never uploaded to a server.
How the README generator works
- Fill in your project name, description, install/run commands, features, and author.
- The tool assembles a standard README.md structure from your answers as you type.
- Copy the Markdown or download it directly as README.md for your repository.
FAQ
What sections does the generated README include?
Title, optional shields.io badges, description, a features list, installation and usage code blocks, license, and author - the standard sections most open-source READMEs use.
Do the shields.io badges require an account?
No. Shields.io badges are static images generated from a URL pattern, so the badge markdown works immediately without signing up for anything.
Can I edit the generated Markdown further?
Yes. Copy or download the file, then edit it in your own editor - it's a normal README.md file with no special formatting tied to this tool.
Is my project information sent anywhere?
No. The README text is built entirely in your browser as you fill in the form - nothing is uploaded.
How we compare
| Feature | Online Tool Store | readme.so | Writing from scratch |
|---|---|---|---|
| Live preview as you fill the form | ✓ | ✓ | ✗ |
| Direct download as README.md | ✓ | ✓ | ✗ |
| No drag-and-drop section editor to learn | ✓ | ✗ | ✓ |
For a fast, simple README from a plain form without a drag-and-drop editor, README Generator keeps it quick.