🔒 Runs in your browser · nothing uploaded
README.md Generator from package.json
Paste a package.json, instantly get a polished GitHub-flavored README — with badges, install commands across all four package managers, scripts table, usage, and contributing. No signup.
✔ 100% Free
✔ No signup
✔ No data sent
✔ GitHub-flavored Markdown
What this generator does
A good README is the difference between a package that gets installed and one that doesn't. This tool turns a package.json — the data you already have — into a polished README with everything a user expects to see in the first 30 seconds: a clear title, a one-line description, badges, install commands across all four major package managers, a runnable usage example, scripts, and contributing notes.
What gets generated
- Title and description from
name and description
- Badges — npm version, monthly downloads, license, bundle size, TypeScript support (auto-detected when
types field is present)
- Table of contents with anchor links to every section
- Installation commands for npm, yarn, pnpm, and bun — toggle any off individually
- Usage — a code block matching the package style (CommonJS, ESM, or CLI depending on
main, module, type, and bin)
- Scripts table from the
scripts field
- Requirements from
engines and peerDependencies
- Contributing — a sensible default section linking to the repo's issues
- License with proper SPDX identifier link
- Author from the
author field, supporting both string and object form
What it intentionally skips
Some README sections are project-specific and can't be inferred from a package.json — like API documentation, screenshots, or architecture diagrams. The generator outputs sensible placeholders for those so you don't forget to add them, marked with HTML comments so they're easy to find and remove.
Frequently asked questions
Is this README generator free?+
Yes — 100% free, no signup, no email required. Everything runs entirely in your browser. We built it as a free tool for the developer community.
Is my package.json data safe?+
Yes. The generator runs entirely in your browser using JavaScript. Your package.json is never sent to any server, never logged, and never stored. Safe for private packages and proprietary projects.
What sections does it generate?+
Title, description, badges (npm version, license, downloads), installation (npm/yarn/pnpm/bun), usage example, scripts table, requirements (Node/peer deps), contributing, license, and author. Toggle individual sections on or off in the toolbar.
Which package managers does it support?+
All four major package managers: npm, yarn, pnpm, and bun. The install section generates commands for all of them by default. You can disable any of the four if you only want to show one.
What badges are included?+
Shields.io badges for: npm version, monthly downloads, license, bundle size, and TypeScript support (auto-detected from the package). All badges link to the relevant npm or GitHub URL. Disable badges entirely with the toolbar toggle.
Does it work for monorepos?+
It works for the package.json of any single package — including ones inside a monorepo workspace. For root-level monorepo package.json files (with private: true and a workspaces array), the README will skip install commands and add a workspaces section listing the packages.
Can I preview the README before copying?+
Yes — toggle the Preview button in the output panel header to see a rendered Markdown preview side-by-side with the raw output. The rendered view shows roughly how GitHub will display the README.