Readmer

Readmer composes README.md files from Jinja2 or Liquid templates.

✨ Features

• Available both as the command-line tool readmer and a polyglot library.
• Build README.md from Jinja2/Liquid/etc templates in .config/readmer/.
• Polyglot software available for Dart, Python, Ruby, Rust, and TypeScript.
• Cuts red tape: 100% free and unencumbered public domain software.

⬇️ Installation

Installation from Crates.io

cargo add --dev readmer

Installation from NPM

npm install --save-dev readmer.js
bun add --dev readmer.js
pnpm add --save-dev readmer.js
yarn add --dev readmer.js

Installation from Pub.dev

dart pub add dev:readmer
flutter pub add dev:readmer

Installation from PyPI

pip install -U readmer
uv add --dev readmer
poetry add --group dev readmer
pdm add -d readmer

Installation from RubyGems

gem install readmer
bundle add readmer --group development

👨‍💻 Development

git clone https://github.com/artob/readmer.git

---