README Generator
Pick the sections your README needs from a library of 17, reorder them, fill each one in, and watch a GitHub-style preview update live — then copy or download the finished README.md.
Runs entirely in your browser — files never leave your device.
Everything here — your section choices and their content — stays in this browser (localStorage) and is never uploaded anywhere. Badge images are fetched from shields.io by your browser when the preview renders them.
How it works
- 01Start from the default section set (Title, Badges, Installation, Usage, Features, Contributing, License, Acknowledgements) or add more from the Available library — Tech Stack, Screenshots, API Reference, Env Variables, FAQ, and others.
- 02Click a section in Selected to edit it in the middle column; use the arrow buttons to reorder or the × to remove it.
- 03Fill in each section's form fields, or edit the Markdown directly for freeform sections like Tech Stack or Roadmap.
- 04Open the Badges section to build shields.io badges — a license badge (synced to whatever you picked in License), npm version, build status, and PRs welcome.
- 05Check the right-hand preview (or switch to Raw for the Markdown source), then copy or download the finished README.md.
Frequently asked questions
What happens if I leave a section blank?
It's left out of the generated README entirely — you won't get an empty "## Usage" heading with nothing under it. Freeform sections (Tech Stack, Roadmap, FAQ, …) work the same way: clear the textarea and that section disappears from the output.
Does this generate an actual LICENSE file?
No, just the README's License section with a short statement and a link to the license text. Add the matching LICENSE file to your repo separately (GitHub can also add one for you from the same choices: MIT, Apache 2.0, GPL v3, BSD 3-Clause, MPL 2.0, Unlicense).
How does the Badges section work?
It's a small shields.io badge builder: a license badge (which follows whatever you picked in the License section by default, or can be set independently), an npm version badge (enter your package name), build-passing and PRs-welcome badges, and an optional "Made with MarkdownLab" badge — all assembled as plain Markdown image links you're free to edit afterward.
Is any of this sent to a server?
No. Every section is assembled into Markdown entirely in your browser's JavaScript. Your section choices and their content are saved to this browser's local storage only (so a reload doesn't lose your work) — nothing is uploaded anywhere. Badge images are the one exception: shields.io fetches those directly when the preview renders them.
Can I keep editing the result after generating it?
Yes — copy or download it, then open it in the Markdown Editor (or any text editor) to keep refining it. This generator gives you a solid structured starting point, not a locked template.