README Generator
Processed Client SideFill in the form and get a polished, GitHub-ready README.md with badges, a table of contents, and standard sections.
Bookmark this tool now — skip the search next time you need it.
About README Generator
This tool runs entirely in your browser. Whatever you paste is processed on your own device and is never uploaded, logged, or sent to any server.
The README Generator turns a short form into a polished GitHub README.md. Fill in the project name, tagline, description, features, install command, and usage example, and it assembles a properly structured Markdown document with a heading hierarchy, fenced code blocks, shields.io badges, and a table of contents whose links actually match the sections that exist. The output is the layout readers expect from a good repository — what the project is, how to install it, how to use it, and what the licence is, in that order — so the file that most visitors judge your project by is not the one you wrote last and least.
Key features
- Complete Markdown README assembled from a form, with a live preview beside it
- shields.io badges for licence, GitHub stars, open issues, and PRs-welcome
- Owner and repository name extracted automatically from a GitHub URL to build the badge links
- Table of contents generated with working anchors, listing only the sections you actually enabled
- Features entered one per line and rendered as a bullet list
- Installation and usage emitted as fenced code blocks, with a language tag on the usage example for syntax highlighting
- Licence section covering MIT, Apache 2.0, GPL, BSD, and The Unlicense, with your name and the current year
- Optional contributing section, and toggles for the badges and the table of contents
- Syntax-highlighted Markdown output and one-click copy, generated entirely in your browser
How to use it
- Enter the project name, a one-line tagline, and a paragraph describing what the project does and who it is for.
- List your features, one per line.
- Fill in the install command and a short usage example, and set the language for the usage code fence.
- Add your GitHub URL so the badges resolve, then choose a licence and enter your name.
- Copy the generated Markdown into README.md at the root of your repository.
Tips & common mistakes
- The first two lines do most of the work. A visitor decides whether to keep reading from the project name and the tagline, so make the tagline say what the thing does rather than how it feels.
- A copy-pasteable usage example beats paragraphs of description. Show the smallest piece of real code that does something useful, and show its output if it has one.
- Set the language on the usage fence — js, python, go — so GitHub highlights it. An unlabelled block renders as flat grey text.
- Skip the table of contents on a short README. Anchor links earn their place in a long document and just add noise to one that fits on a screen.
- The star and issue badges only work once the repository URL is filled in, because they are built from the owner and repository name in that URL.
- Generating the licence section does not license the project. You still need the actual LICENSE file in the repository — GitHub reads the file, not the README.
- Add a screenshot or a terminal recording once the structure is in place. For anything with visible output it is the highest-value thing a README can contain, and it is the one part a generator cannot write for you.
- Starting a new repo? Pair this with a .gitignore Generator entry for your stack.