readie

Readie

Developer-first CLI for generating polished, consistent README files from a simple config.

Table of Contents

• Key Features
• Prerequisites
• Quick Start
• Manual Installation
• Usage
• Available Commands
• Global Flags
• Documentation

Key Features

• Generate a single project README or many READMEs across a workspace
• Schema-backed configuration with editor autocomplete and validation
• Composable sections for installation, quick start, commands, flags, and more
• Supports custom markdown sections, badges, and project-specific content
• Easy onboarding with starter config generation
• Dry-run and strict workspace options for safe large-scale updates

Prerequisites

• Node.js 18 or later
• npm, pnpm, or yarn
• A project with a readie.json config file

Quick Start

Create a starter config and generate your README in minutes:

# 1) Initialize a config
npx readie init

# 2) Generate README.md from readie.json
npx readie

For monorepos/workspaces:

npx readie generate:workspace --root ./packages --config-name readie.json

This workflow helps teams keep README files consistent while still allowing per-project customization.

Manual Installation

npm install -g readie

You can also run it without global install via npx readie.

Usage

• Create a config file with npx readie init.
• Run npx readie (or npx readie generate) to generate one README.
• Use npx readie generate:workspace --root ./packages to generate for multiple packages.
• Use --dry-run to preview changes and --strict to fail CI on generation errors.
• Extend generated docs with rich markdown via quickStart, customSections, and footer.
• Use placeholders in top-level strings of readie.global.json: {{title}}, {{packageName}}, and {{packageNameEncoded}}.

{
	"banner": "<h1 align=\"center\">{{title}}</h1>",
	"footer": "https://example.com?ref={{packageNameEncoded}}"
}

# Single project
npx readie --config ./readie.json

# Workspace with package filtering
npx readie generate:workspace --root ./packages --package ui --package api --dry-run

Available Commands

• readie: Generate a README from the local readie.json (default command).
• readie generate: Explicit single-project generation command.
• readie generate:workspace: Generate READMEs for multiple projects in a workspace.
• readie init: Create a starter readie.json in the current directory.

Global Flags

• --help, -h: Show command help.
• --config, -c: Set a custom config path for supported commands.

Documentation

For further information, guides, and examples visit the reference documentation.