README Generator

Create a Markdown README with project details, features, installation steps, badges and optional API or configuration tables. Preview it live, then copy or download the file.

README Generator — Create Professional GitHub-Ready README.md Files with Badges, API References, Configuration Tables, and Live Markdown Preview

  1. Choose a format preset to get started quickly: Standard for a balanced README with essential sections (title, description, features, installation, usage, contributing, license), Minimal for lightweight projects needing just the basics (name, install command, and a brief description), or Detailed for production-grade open-source libraries requiring full API reference tables, configuration option grids, acknowledgments, contact info, and support sections. Each preset intelligently toggles the relevant sections — you can always fine-tune by enabling or disabling individual sections afterward.
  2. Fill in each section using the structured form on the left: provide your project name and tagline for the hero header, select badge types (License, Version, Build, NPM, Downloads) to display at the top of your README, list features as bullet points, choose your package manager (npm, yarn, pnpm, pip, cargo, go) to auto-generate the correct install command, add configuration options with type annotations (string, number, boolean, object, array) to build a formatted options table, and define API endpoints with method, path, description, and authentication requirements for a clean API reference section.
  3. Monitor the live preview panel on the right — it renders your README in real-time as you type, showing exactly how it will appear on GitHub, GitLab, or any Markdown-compatible platform. When satisfied, click Copy Markdown to grab the raw Markdown text to your clipboard, or Download README to save a README.md file directly to your computer. The generated Markdown follows CommonMark and GitHub Flavored Markdown (GFM) conventions — compatible with GitHub, GitLab, Bitbucket, Gitea, and static site generators like Hugo, Jekyll, and Docusaurus.

Enable JavaScript to use these tools.