Readma — Beautiful, effortless README generator

See it in action

Generate the whole workspace in a single run — root readme with the package table, plus one readme per member with its own badges and installation snippet.

zsh — readma

$ deno run -A jsr:@readma/cli gen

Starting readma generation

Rendering "workspace root" readme

Rendering "@readma/core" readme

Rendering "@readma/cli" readme

Rendering "@readma/pkg-json" readme

✓ 4 readmes written

$ git status --short

M README.md

M packages/core/README.md

M packages/cli/README.md

M packages/pkg-json/README.md

Readma generating readme files in a terminal

Everything a good README needs, generated

Readma parses the project files you already maintain — deno.json, package.json, Cargo.toml, pnpm-workspace.yaml — and turns them into a standardized, badge-complete README with your content in the sections that matter.

Workspace compatible

Drop Readma at the root of a Deno, pnpm/npm or Cargo workspace: every member gets its own README, and the root gets a package table linking to all of them.

Automatic shields

Version, codecov, stars, forks, issues, pull requests, last commit, release, license… 14 built-in badges with sane links, each one disableable and extensible with your own.

CLI toolkit

init scaffolds a config from your git remote, language and license, gen renders the readmes, validate lints the config, schema powers editor autocompletion.

CI friendly

gen --check exits with code 2 when a README is out of sync with the config, and --offline skips every network call. Drop both in your pipeline and forget about stale docs.

GitHub compatible anchors

The generated table of contents uses the exact same anchor algorithm as GitHub — emojis included — so every in-page link works in the rendered README and in editors.

Quality gate

100% test coverage across lines, branches and functions, deno lint plus oxlint in pedantic mode with zero suppressions. Built to be relied upon.

Up and running in three commands

No interactive wizard, no yaml soup: a single TypeScript file you already know how to edit.

Scaffold the config

init detects your git remote, workspace layout, language and license, then writes a typed readma.config.ts at the root.

deno run -A jsr:@readma/cli init

Make it yours

Fill the sections with your own markdown — features, installation, roadmap — and tweak badges, table of contents or badge style in one typed object.

sections: {
  features: `- Workspace compatible
- Automatic shields`,
  roadmap: `- [x] Ship
- [ ] Iterate`,
}

Generate every readme

One command renders the workspace root and every member readme. Re-run it any time, and let --check keep them in sync in CI.

deno run -A jsr:@readma/cli gen

One monorepo, three focused packages

Readma dogfoods its own philosophy: the docs you are reading describe a workspace whose README is generated by Readma itself.

Command line@readma/cli

The entry point for humans and CI: init, gen (with --check, --dry-run, --stdout, filters), validate and schema commands.

Rendering engine@readma/core

Pure rendering primitives: context resolution, shields, GitHub-compatible table of contents, section pipeline and MDX support.

Utility@readma/pkg-json

A typed, dependency-free helper to safely read and parse package.json files, used by workspace detection.

Ship a README that rocks

Scaffold, customize, generate — and never hand-write a badge again.

Read the quick start Configuration reference