Skip to content
Run here 100% in your browser, no upload, no login

README Generator

Fill in name, description, install and usage, and get a clean Markdown README to copy.

Generated README

How to use it

  1. Type the project name and a one-line description.
  2. Enter the install command and, optionally, a usage snippet - both are wrapped in code fences.
  3. Pick a license or choose none; a badge row can be added automatically.
  4. Copy the Markdown or download it as README.md.

Common use cases

Why it stays private

The form never leaves your browser; the Markdown is assembled locally and handed straight to the clipboard or a download.

FAQ

Q: Where do the badges come from? A: The badges are static shields.io image links embedded in Markdown. They render on GitHub and most Git hosts once the file is committed; the tool itself never loads them.

Q: Can I add sections like Contributing or Tests? A: The generated file is plain Markdown. Copy it into your editor and extend it - the tool keeps the common sections consistent so additions have a stable base.

Q: What does the "None" license option produce? A: A section noting that no license has been chosen and the default is all rights reserved, which is an accurate description of an unlicensed public repository.

Your data stays on this device

README Generator runs 100% locally. Everything you paste or drop is processed by your own browser and never transmitted. Nothing is stored on our servers — close the tab and it is gone.

Nothing you type is sent to a server, logged, or used for analytics. The page works even with your network disconnected after first load.