README Generator
Build a clean README.md from a few project fields.
How to use
- 1 Enter your project title and a short description.
- 2 List the features, install command and a usage example.
- 3 Pick a license and toggle the table of contents, contributing section and badge.
- 4 Copy the generated Markdown into your repository as README.md.
About README Generator
The README Generator turns a handful of project details into a tidy, conventional README.md that follows the structure reviewers and package registries expect.
Fill in your project title, a one-line description, a feature list, install commands, a usage example and a license, and the tool assembles a properly formatted Markdown document with sensible headings, fenced code blocks and an optional badge.
It is built to keep the output clean.
Sections you leave blank are simply omitted, so you never end up with an empty "Usage" header or a dangling list.
The feature list accepts either commas or new lines and is rendered as bullet points; install commands are wrapped in a bash code fence; and the usage example uses whatever language you specify for syntax highlighting on GitHub.
You can toggle a generated table of contents with working anchor links, a friendly contributing section, and a shields.io license badge at the top.
The license section picks up the author name you provide so the copyright line reads correctly.
A live preview updates as you type, and one click copies the finished Markdown straight to your clipboard, ready to drop into a new repository.
Everything runs locally in your browser — nothing about your project is uploaded or stored — and it keeps working offline once the page has loaded, making it a quick way to give any project a professional first impression.
FAQ
Will empty fields create blank sections?
No. Any section whose input you leave empty is skipped entirely, so the README stays clean with no orphaned headings or empty code blocks.
How do I separate features?
Type each feature on its own line, or separate them with commas. Both work, and each one becomes a bullet point in the Features list.
Does the table of contents link correctly on GitHub?
Yes. The contents links use GitHub-style anchor slugs generated from each heading, so they jump to the right section when rendered on GitHub.