quickstart

Readme-Gen Quickstart

CLI that generates beautiful README.md files

Commands

• readme-gen <resource> <action> — Execute readme-gen commands

Installation

npm install -g readme-md-generator

Basic Usage

Generate a new README interactively:

readme-md-generator

Generate README with specific template:

readme-md-generator --template path/to/template.md

Options

readme-md-generator --help           # Show help
readme-md-generator --yes            # Skip prompts, use defaults
readme-md-generator --path ./docs    # Output to specific path

Features

• Interactive prompts for project details
• Multiple built-in templates
• Automatic badge generation
• Customizable sections