README Generator
Scaffold a professional README.md from clickable section blocks — title, badges, description, auto-TOC, installation, usage, features, API, contributing, license — with project templates (npm, GitHub, library, CLI, profile), an inline Shields.io badge builder, a license picker with full SPDX text (MIT, Apache-2.0, GPL-3.0, …), import of existing READMEs, and a live preview. 100% client-side.
About README Generator
Scaffold a professional README.md from clickable section blocks — title, badges, description, auto-TOC, installation, usage, features, API, contributing, license — with project templates (npm, GitHub, library, CLI, profile), an inline Shields.io badge builder, a license picker with full SPDX text (MIT, Apache-2.0, GPL-3.0, …), import of existing READMEs, and a live preview. 100% client-side. Everything runs locally in your browser — your data never leaves your device.
How to use
- Enter your input in the tool above.
- Adjust any options to your preference.
- Use the Copy or Download buttons to save the result.
- Everything happens locally — your data never leaves your browser.
FAQ
How does the README generator work?
Pick a project template (npm, GitHub, library, CLI, or GitHub profile), then add, reorder, or remove section blocks. Each section has per-field inputs with sensible placeholders. The live preview on the right updates as you type, and Copy / Download give you a clean README.md ready to drop into your repo. A [TOC] marker is auto-expanded into a clickable table of contents with anchor links that resolve on GitHub.
Which licenses are supported with full SPDX text?
MIT, Apache-2.0, GPL-3.0, BSD-3-Clause, ISC, MPL-2.0, Unlicense, and a Proprietary placeholder. The full license body is generated with the correct year and copyright holder substituted into the template variables. The license section in the README also emits a Shields.io badge so visitors see the license at a glance.
How do Shields.io badges work in this tool?
Pick a badge preset (npm version, build status, downloads, license, GitHub stars, coverage, TypeScript, bundle size, etc.) or build a custom static badge. The tool constructs the correct shields.io URL — including URL-encoded label, message, and color — and inserts it as markdown image syntax in the badges section. Badges can be enabled or disabled individually.
Can I re-edit an existing README.md?
Yes. Paste your existing README into the Import box and click Import. The parser splits the document back into sections by markdown headings (H1/H2), extracts badge markdown image lines, the fenced license block, and inline code blocks, then loads them into the editor so you can edit and re-export. Re-importing the same README round-trips cleanly.
What extra features does this tool have versus readme.so?
(1) Section library with 12 block types (title, badges, description, TOC, installation, usage, features, API, contributing, license, screenshots, collapsible details). (2) 5 project templates (npm, GitHub, library, CLI, profile). (3) Auto-generated TOC with anchor links. (4) Inline Shields.io badge builder (15+ presets + custom). (5) License picker with 8 full SPDX texts and year/author substitution. (6) Re-import existing README.md. (7) Collapsible <details> sections. (8) Per-section enable/disable. (9) Section reorder. (10) Live markdown preview. (11) Copy / Download .md. (12) Stats (sections, badges, chars, words). (13) History (localStorage, last 20). (14) Shareable URL. 100% client-side — your project info is never uploaded.
Related tools
.bashrc / .zshrc Alias & Config Manager
Build shell aliases, functions, exports, and PATH edits in a visual editor, then export a clean, commented .aliases file sourced from both .bashrc and .zshrc — with shadowing detection against shell builtins and common CLI tools, function suggestions when args are needed, starter packs (git, docker, kubectl, navigation, safety, ls, dev, devops, data science), import of existing rc files, dedupe, history (localStorage), and shareable URL. 100% client-side.
Add / Subtract Date Calculator
Add or subtract years, months, weeks, days, hours, minutes and seconds from a starting date/time. Calendar-day or business-day mode with custom weekend + holiday list. Month-end policy toggle (clamp to last day vs overflow). Repeat/series mode (e.g. every 2 weeks x 10) with CSV export. Shareable URL. 100% client-side.
Age Calculator
Calculate exact age from a birth date in calendar years/months/days (no negative-day bugs) plus totals in months/weeks/days/hours/minutes/seconds. Next-birthday countdown with weekday. Feb-29 birthday policy toggle. Milestones (1,000 days, 10,000 days, 1 billion seconds). Zodiac sign + Chinese zodiac. Age gap comparison. Shareable URL. 100% client-side.