README Generator

Describe your project once and get a clean, well-structured README.md with badges, install steps, usage examples, and a license section. Everything runs in your browser.

How it works

Step 1

Describe your project

Enter a name, tagline, and description, plus your GitHub repository and npm package if you have them.

Step 2

Pick sections and badges

Tick the badges you want, list features one per line, and add install and usage snippets.

Step 3

Copy or download

Check the preview, then copy the Markdown, download README.md, or open it in the editor for fine-tuning.

What makes a good README

A README is the front door of a project. Visitors decide in seconds whether a repository is worth their time, so the best READMEs answer three questions immediately: what the project does, how to install it, and how to use it.

This generator lays out those sections in the order readers expect, adds status badges that signal the project is maintained, and finishes with contributing and license information so others know how they can help and what they are allowed to do with the code.

Badges without the guesswork

Badge URLs are easy to get subtly wrong. Enter owner/repo once and the generator builds correct shields.io links for the license, GitHub stars, and GitHub Actions status, plus npm version and download badges when you provide a package name.

Frequently asked questions

Is the generated README compatible with GitHub?

Yes. The output is standard GitHub Flavored Markdown, so it renders correctly on GitHub, GitLab, Bitbucket, npm, and most documentation sites.

Are my project details uploaded anywhere?

No. The README is built in your browser and saved only in this browser. Badge images are loaded from shields.io when the preview is shown.

Can I edit the README after generating it?

Yes. Use "Open in editor" to continue in the full Markdown editor with live preview, or copy the Markdown into your own editor.

Which licenses are supported?

MIT, Apache-2.0, GPL-3.0, BSD-3-Clause, ISC, MPL-2.0, and the Unlicense. The generator links to a LICENSE file; add the full license text to your repository separately.

Related tools: Badge generator · TOC generator · Markdown editor