Readmer.rs

Readmer composes README.md files from templates.

[Features] | [Prerequisites] | [Installation] | [Examples] | [Reference] | [Development]

✨ Features

• Available both as the command-line tool [readmer] and as a Rust library.
• Compose README.md files from Liquid templates in .config/readmer/.
• 100% pure and safe Rust with minimal dependencies and no bloat.
• Designed for #![no_std] environment compatibility from the get-go.
• Supports opting out of any feature using comprehensive feature flags.
• Adheres to the Rust API Guidelines in its naming conventions.
• Polyglot software also available for Dart, Python, Ruby, and TypeScript.
• Cuts red tape: 100% free and unencumbered public domain software.

🛠️ Prerequisites

• Rust 1.85+ (2024 edition)

⬇️ Installation

Installation via Cargo

cargo add --dev readmer

Installation in Cargo.toml

Enable all default features:

[dev-dependencies]
readmer = { version = "0" }

Enable only specific features:

[dev-dependencies]
readmer = { version = "0", default-features = false, features = ["alloc"] }

👉 Examples

Importing the Library

use readmer::*;

📚 Reference

docs.rs/readmer

👨‍💻 Development

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