create-readme GitHub

Great READMEs,
less busywork.

create-readme scans your repository, asks only what’s missing, and generates clean GitHub-flavored Markdown you can review before writing.

View on GitHub Read the v2 spec

$ create-readme ./acme

Found package.json · Node.js · MIT · GitHub Actions

4 facts confirmed · 3 questions remaining

✓ README preview

# acme

A tiny toolkit for building reliable CLIs.

## Features

– Fast and lightweight
– Zero runtime dependencies
– Built for Node.js ≥ 22

## Installation

npm install acme

Run from source today git clone https://github.com/gregroyclark/create-readme && cd create-readme && npm install && npm link

Your repository already knows a lot.

create-readme detects the facts it can with zero setup, then asks for the human details only you know.

  • Package managerpackage.json · Node.js
  • LicenseLICENSE · MIT
  • CI/CD.github/workflows · Actions
RepositoryScannerGuided questionsREADME.md

One engine, three ways to work.

The same repository scanner and Markdown renderer will power every surface.

CLI

Available in v2 beta

The fastest way to generate a polished README from your terminal.

$ create-readme .

✓ Scanning repository Done

✓ Detecting facts Done

✓ Rendering README.md Done

▣ README.md generated

Review: open README.md
Commit: git add README.md

View CLI docs

Studio

Planned

A focused visual workspace to compose, preview, and refine your README.

SectionsOverviewInstallationUsageLicense
Preview# create-readme

Generate thoughtful README files from facts already in your repo.

npm v2 beta MIT
## Quick start

A future local-first surface—no signup promised.

GitHub Action

Planned

Keep README changes visible and reviewable in the pull-request flow.

✓docs: refresh READMEsucceeded
  • ✓ Check out repository
  • ✓ Set up Node.js
  • ✓ Generate README
  • ○ Commit README.md
create-readme --check .

Planned after the CLI contract settles.

Built in the open.

Deterministic, offline-friendly, and MIT licensed.
No account or AI key required.

Explore the source Read the v2 spec