FREE TOOL

README Generator

Paste a GitHub repo or build by hand. Live preview, badges, AI polish, clean export.

Create a professional README.md in seconds. No account needed to build one yourself.

LIVE BUILDER
Details
Project name
Tagline
Repository URL
Description
Install command
Usage
Features (one per line)
Scripts (name: command, one per line)
License
Extra sections
Building by hand is free and stays in your browser. Importing a repo needs a quick verification.
Preview

acme-cli

License Stars Issues

Ship release notes straight from your commits.

Table of Contents#

acme-cli turns your merged pull requests into a clean, human-readable changelog. Point it at a repository and it does the rest.

Installation#

Shell
npm install -g acme-cli

Usage#

Shell
acme-cli generate --since v1.2.0

Features#

  • Zero-config setup
  • Conventional-commit aware
  • Markdown & JSON output

Scripts#

ScriptCommand
buildtsc -p .
testvitest run

Contributing#

Contributions are welcome! Please open an issue or a pull request.

License#

Released under the MIT license.

Tech Stack#

  • TypeScript
  • Node.js
Commit this as README.md at the root of your repository.
Import from GitHub

Paste a public repository URL and we read its description, languages, scripts, and license to pre-fill a complete README.

Live preview

See the rendered README as you type. Badges, table of contents, code blocks, and tables all update instantly.

Polish with AI

Turn a rough draft into clear, welcoming prose with one click. It improves wording without inventing features.

Clean export

Copy the Markdown or download README.md, ready to commit to the root of your repository. Shareable via link, too.

Frequently asked questions

Is this README generator free?

Yes. Building a README by hand is completely free with no sign up. Importing a public GitHub repository or using AI polish asks for an email once, so we can keep the tool fast and abuse-free.

What does importing from GitHub do?

Paste a public repository URL and we read its public metadata — description, topics, primary languages, package.json scripts, and license — then assemble a structured README you can edit. We never access private repositories.

Does my README leave my browser?

When you build by hand, everything stays in your browser. Importing a repo or polishing with AI sends that request to our server so we can read the public repo or run the model, but we don't store your edited document.

What is the AI polish?

It rewrites your draft for clarity and flow while preserving every command, link, badge, and section. It will not invent installation steps, APIs, or features that aren't already in your draft.

How do I keep a README accurate over time?

A README drifts the moment the code changes. Moxie Docs connects to your repository and keeps your README and other docs current automatically on every merge — the same problem this tool only solves once.

KEEP IT TRUE

Generating a README once is easy. Keeping it accurate isn't.

The moment your code changes, your README starts drifting. Moxie Docs connects to your GitHub repositories and keeps your README and the rest of your docs current automatically — opening a single reviewable Cleanup PR every Friday.

No credit card required to start. Cancel anytime.