About this README generator
A good README is the first thing people see on GitHub. Fill in your project's name, description, features, installation and usage, pick a license and the generator builds a well-structured README.md with shields.io badges, a table of contents and contributing guidelines, with a live preview.
How to use the README Generator
- Fill in your project details.
- Choose badges and sections.
- Copy or download README.md and commit it to your repository.
Frequently asked questions
Where do the badges come from?
Badges are served by shields.io. Enter owner/repo to add stars, issues and last commit badges for your GitHub repository.
Can I edit the result?
Yes. Copy the Markdown and adjust it in your editor; it is plain GitHub Flavored Markdown.
Is my data safe?
Yes. The tool runs entirely in your browser using WebAssembly. Nothing you type or upload is sent to a server, logged or stored.
Is it free?
Yes, completely free with no sign-up, no limits and no watermarks. It also works offline once the page has loaded.