README Generator
Fill in title, tagline, features, install and usage — get a tidy README.md in Markdown, ready to commit.
A README is the front door of a project: most visitors decide in under a minute whether it solves their problem, and they decide from the title, the tagline and the feature list — in that order. This generator enforces that structure so nothing essential is forgotten. Worked example: title My Tool, tagline Does things., features Fast and Small, install npm i my-tool, usage my-tool run and license MIT produce a document that starts with # My Tool, then a ## Features section with - Fast and - Small, a ## Installation section containing npm i my-tool in a code block, a usage block, and a ## License section naming MIT.
Your project wording is assembled into Markdown in this browser. It is never uploaded, stored or put into a link; it stays in this page on your device until you copy or download it.
Quick answers
How do I create a README.md?
Enter a title, tagline, features (one per line), an install command, a usage example and a license. My Tool with features Fast and Small generates a file starting # My Tool with a ## Features list, an ## Installation block and a ## License section.
Download it as README.md and commit it at the repository root — then keep the install and usage commands honest as the project changes.
What makes a good README feature list?
Concrete, testable capabilities in the user’s language: what it does, not how it feels. “Exports CSV” is a feature; “powerful and intuitive” is not.
Three to seven true bullets outperform a long aspirational list, because readers scan the list to decide whether to install at all.
How to use
- Enter the project title and a one-line tagline that says what the project does and who it is for.
- List the features, one per line — concrete capabilities, not marketing adjectives. Three to seven honest bullets beat twenty vague ones.
- Add the exact install command and a usage example a new user can copy and run without editing.
- Set the license, then copy the Markdown or download it as README.md and commit it at the root of your repository.
About this tool
Keep the generated skeleton honest. The feature list should name things the software actually does today, the install command should be the one you tested on a clean machine, and the usage example should be a real invocation with real output expectations — a README that overpromises is worse than a short one. Once the skeleton is committed, grow it in place: screenshots, configuration, contributing notes and a changelog link all belong after these core sections, not instead of them.
Frequently asked questions
What sections does the generated README contain?
A title heading, the tagline, Features as a bullet list, Installation and Usage as fenced bash code blocks, and a License section — the minimum a reader needs to judge, install and try a project. You can add more sections in your editor afterwards.
Can I write features in any format?
One feature per line in the features box. Each non-empty line becomes one Markdown bullet, in the order you wrote them, so keep each line to a single concrete capability.
Which license should I pick?
That is a legal choice only you can make for your project — MIT and Apache-2.0 are common permissive choices, GPL family licenses are copyleft. The generator simply prints the name you enter; it does not advise, and the full license text still belongs in a separate LICENSE file.
Is my project description stored anywhere?
No. The Markdown is assembled in this browser, and your wording is never uploaded, stored or put into a link.
First time embedding? Read the step-by-step guide →
More free tools
UUID Generator
Generate random v4 UUIDs in bulk.
JSON Formatter & Validator
Format, minify and validate JSON in one click.
What Is My IP
See your public IP address instantly. No sign-up, nothing stored.
Regex Tester
Test, check and validate regular expressions with live highlighting.
JWT Decoder
Decode a JWT token without the secret — see its header and payload.
SHA-256 Hash Generator
Generate SHA-256 / SHA-512 hashes instantly.