# Quickstart

> Readme-Gen Quickstart

- Skill: `javimosch/quickstart-2220` (Agent Skill)
- Install (CLI): `npx skillmds@latest add javimosch/quickstart-2220`
- Raw SKILL.md: https://api.skillmd.com/api/skills/javimosch/quickstart-2220/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: javimosch (https://skillmd.com/u/javimosch)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/javimosch/quickstart-2220

---

# Readme-Gen Quickstart

CLI that generates beautiful README.md files

## Installation

```bash
npm install -g readme-md-generator
```

## Basic Usage

Generate a new README interactively:
```bash
readme-md-generator
```

Generate README with specific template:
```bash
readme-md-generator --template path/to/template.md
```

## Options

```bash
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