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

Frequently asked questions

Can I use README Generator to generate a README scaffold for a Node.js library?

Yes. README Generator can generate a README scaffold for a Node.js library, directly in your browser.

Can I use README Generator to add CI and npm version badges to a project?

Yes. README Generator can add CI and npm version badges to a project, directly in your browser.

Can I use README Generator to generate a CONTRIBUTING.md and CODE_OF_CONDUCT.md for a new repo?

Yes. README Generator can generate a CONTRIBUTING.md and CODE_OF_CONDUCT.md for a new repo, directly in your browser.

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.