README Generator

Fill in project details and generate a well-structured README.md scaffold with badges, installation instructions, features, contributing guide, and license section.

Ln: 1  Col: 1 713 chars · 713 B13pxMarkdown

Fill in the form fields — the README updates live. Download or copy the Markdown, or export as a Word document.

README Generator

Fill in project details and generate a well-structured README.md scaffold with badges, installation instructions, features, contributing guide, and license section.

Common uses

  • Generate a README scaffold for a Node.js library
  • Add CI and npm version badges to a project
  • Generate a CONTRIBUTING.md and CODE_OF_CONDUCT.md for a new repo

Also searched as

  • readme generator online
  • github readme template
  • readme.md builder
  • add badges to readme
  • contributing.md generator
  • code of conduct generator
  • readme for npm package
  • open source readme template
  • readme with installation and license sections

Frequently asked questions

How do I create a README.md for my project?

Fill in your project details and the generator outputs a structured README scaffold with badges, installation, features, contributing and license sections.

Can it generate CONTRIBUTING.md and CODE_OF_CONDUCT.md?

Yes. Toggle CONTRIBUTING.md and CODE_OF_CONDUCT.md under Community health files and download each one; the code of conduct is based on the Contributor Covenant.

Can I add shields.io badges?

Yes. With the GitHub badges option on and a GitHub repo URL entered, the README gets shields.io badges for license, stars and issues.

Is my data uploaded to a server?

No. This tool runs entirely in your browser — your input is processed locally on your device and is never uploaded or stored on a server.