Fill a simple form to generate a clean, well-structured Markdown README with badges, install steps and usage examples.
🔒 Your project info stays on your device and is never uploaded.
A clear README helps people understand, install and use your project quickly. Fill in the fields once to generate a well-structured Markdown file with a title, badges, table of contents, installation and usage sections, features list and license.
Optionally add npm version, license and build-status style badges from shields.io.
Switch to the Preview tab to see exactly how the README will render on GitHub.
The README is generated entirely in your browser. Nothing is uploaded.
Title, description, badges, table of contents, installation, usage, features, license and contributing sections, each optional.
Badges use shields.io, a free service for generating simple status badges from a URL.
Yes. The live preview pane renders the generated Markdown so you can check formatting before copying it.
No. The README is generated entirely in your browser.