Dump your project in (manifests, file trees, half-written notes) and get back a structured README. Then shape it with a live GitHub-accurate preview, a badge builder, and five very different templates.
Every section toggleable, in any template
1
Preface does the mechanical work so the only thing left is the part that needs you.
Paste a package.json, a file tree, or a pile of source files. Preface parses manifests, detects your stack, and pulls out scripts, environment variables and structure.
Markdown on the left, a GitHub-accurate preview on the right, in both light and dark theme. Form and markdown stay in sync until you take over.
Paste a GitHub URL. Description, license, language breakdown, topics and root manifests come back filled in.
Eighty shields.io badges across languages, frameworks, databases and infrastructure, plus live star, issue and last-commit badges.
The same content rendered as a minimal library README, a conventional OSS layout, a loud showcase page, a dense reference doc, a CLI page, an Action, a monorepo, or a profile README.
The analyzer, editor, preview, badges and templates all run in your browser. No account, no key, no upload.
Switching template never loses content. The same structured data is re-rendered with different chrome.
Four steps, about thirty seconds.
Paste project content, or pull straight from a GitHub URL.
Manifests, scripts, env vars and structure, parsed in an instant.
Toggle sections, pick badges, switch template. Preview updates live.
Copy to clipboard or download README.md. Nothing to sign up for.
No account, no upload, nothing to configure. Open the builder and paste something.
Open the builder