Preface

What it does

Preface reads a pasted project dump, package.json, file tree, source files, or an imported GitHub repo, and turns it into a structured, accurate README without the copy paste template guesswork. Pick from eight templates, drop in any of roughly eighty shields.io badges, and watch a live GitHub accurate preview update as you go. An optional AI pass runs against a local model by default, so the whole thing works without ever sending your code anywhere.

Notable features

• Deterministic parser reads package.json, Cargo.toml, pyproject.toml and more
• GitHub repo import pulls description, license and language breakdown
• Eight switchable README templates and roughly eighty badge combinations
• Live GitHub accurate markdown preview, light and dark
• Optional AI pass runs locally by default