README Generator

Pick the template that matches your project: Minimal (title + description + license, for small utility libraries), Standard (adds features and usage sections, for typical open-source projects), Library (adds an API section with function signatures, for reusable libraries), or Web App (adds a Getting Started section with repo clone + dev-server instructions). Each template pre-fills the appropriate sections so you don't stare at a blank file.

Once you have the README text, you can render it to HTML with the Free Markdown to HTML Converter to preview how it'll look on your project homepage.

Toggle Include badges to add a row of shields.io badges at the top of your README — npm version, license, and GitHub Actions build status. The badges are generated from your project name and GitHub username, so they update automatically once your project is published. You can add more badges manually after copying (downloads, coverage, dependencies, Discord, Patreon, etc.).

For a table of contents linking to each README section, use the Free Markdown TOC Generator on the generated output.

Pick from MIT, Apache 2.0, GPL-3.0, BSD 3-Clause, ISC, or Unlicense — the 6 most common open-source licenses. The README's License section updates instantly, and if badges are enabled, the license badge updates to match. For other licenses or custom arrangements, edit the License section after copying.

If your project's README needs to include tables (feature comparisons, config options, environment variables), the Free Markdown Table Generator builds them visually.

Toggle the Contributing section on or off to include a welcoming blurb inviting pull requests and issue reports. Toggle the Tests section to include instructions for running your test suite (defaults to npm test, editable after copying). Both are off by default on the Minimal template; on by default on others. Add them à la carte as your project grows.

After generating, clean up any inconsistencies with the Free Markdown Formatter.

Every keystroke updates the output panel on the right — no 'generate' button required. See your README take shape as you fill in project name, tagline, description, author, install command, usage code, and license. This tight feedback loop makes it easy to iterate: tweak a line, see the result, tweak again.

For a side-by-side rendered preview of how the README will actually look when GitHub displays it, use the Free Markdown Live Preview tool after copying.

Project info, template rendering, output generation — all runs inside your browser tab. Nothing is uploaded, nothing is logged. Your unreleased project's internals stay private until you publish. The only thing that leaves your browser is the network request to shields.io when the badges load in someone else's preview — and even that's a cached CDN fetch, not a request from this tool.

Same privacy guarantee on every client-side tool: Free HTML to Markdown, Free Markdown Word Counter, and the rest all work locally.