Quickstart

Readme-Gen Quickstart

javimosch Updated

File contents

Readme-Gen Quickstart

CLI that generates beautiful README.md files

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

javimosch/supercli/tree/main/plugins/readme-gen/skills/quickstart commit 8d65cb5a87

Frequently asked questions

npx skillmds@latest add javimosch/quickstart-2220