How to use the README Generator
- Fill in your project's details — leave out anything you don't need.
- Turn badges, a table of contents and a contributing section on or off.
- Download README.md and commit it.
What does this tool do?
A good README answers what the project does, why it's useful, how to install and use it, and how to contribute. Badges from shields.io show license, stars and activity when you enter your GitHub repo. Lists and commands are formatted automatically.
Everything runs in your browser — nothing you paste is uploaded.
Why use it?
- Badges and TOC.
- Formats commands as code.
- Standard sections.
Use cases
- New open-source projects.
- Portfolio projects that recruiters will look at.
- Internal tools your team needs to set up.
A README that answers the basics
Name and one-line description → badges → features → install (npm install my-tool) → usage with a code example → contributing → licence. Visitors decide in seconds whether a project is for them, so put the one-line description and a usage example near the top.
Common mistakes
- No usage example, so visitors can't see what the project does.
- Install steps that skip prerequisites like the Node version.
- Leaving the README unchanged after the project changes.
Privacy
Everything you type is processed in your browser. Nothing you enter is sent to our servers or stored by us. There's no account to create and nothing to install.
Frequently asked questions
Where do the badges come from?
shields.io, using your GitHub repository details.
Do I need a licence section?
Yes, for open source — without a licence, others can't legally reuse your code.
Can I edit it after downloading?
Yes, it's plain Markdown.
Content last updated . See how M2Toolkit works.