README Generator

What it does

README Generator scans your project structure — package.json, source files, existing docs, CI configs — and produces a complete, production-ready README.md. It infers the project description, tech stack, and key features automatically, then asks a handful of targeted questions if any required information is missing.

The output follows GitHub-optimised Markdown conventions with proper badge syntax, collapsible sections, and a table of contents that links to each major section.

How to install

npx plugins add readme-gen

What gets generated

• Badges: npm version, build status, coverage, license — all auto-configured
• Installation: package manager commands detected from lockfiles
• Quickstart: first-run example extracted from tests or main entry point
• API reference: exported functions with descriptions from JSDoc / docstrings
• Contributing: standard fork-and-PR workflow with branch naming convention
• License: detected from LICENSE file and linked correctly

Example prompt and output

# User prompt
Generate a README for this project

# my-auth-lib

![npm](https://img.shields.io/npm/v/my-auth-lib)
![build](https://github.com/owner/my-auth-lib/actions/...)
![coverage](https://codecov.io/gh/owner/my-auth-lib/badge.svg)
![license](https://img.shields.io/badge/license-MIT-green)

A lightweight JWT authentication library for Node.js with
first-class TypeScript support and zero production dependencies.

## Installation

```bash
npm install my-auth-lib
# or
pnpm add my-auth-lib
```

## Quick Start

```typescript
import { createAuth } from 'my-auth-lib';
const auth = createAuth({ secret: process.env.JWT_SECRET });
const token = await auth.sign({ userId: '123' });
```

--- (API Reference, Contributing, License sections follow) ---

Configuration

{
  "readme-gen": {
    "template": "standard",
    "include-toc": true,
    "badge-style": "flat-square",
    "output": "README.md"
  }
}