readme-forge 📝

Generate professional README.md files from your package.json. Zero config, instant results.

Why?

Starting a new project? Don't write your README from scratch. readme-forge reads your package.json and generates a clean, professional README instantly.

Install

npm install -g readme-forge

Usage

# Generate README from current directory's package.json
readme-forge

# Include badges and table of contents
readme-forge --badges --toc

# Generate from specific directory
readme-forge --dir ./packages/my-lib

# Preview without writing
readme-forge --stdout

# Overwrite existing README
readme-forge --force

What it generates

• Title from package name
• Description from package.json
• Badges (npm version, license, GitHub stars) with --badges
• Table of contents with --toc
• Install instructions (detects CLI vs library)
• Usage examples (npx for CLIs, require for libraries)
• npm scripts table
• Dependencies list
• Keywords from package.json
• License with author link

Options

--dir, -d       Source directory (default: .)
--output, -o    Output file (default: README.md)
--stdout        Print to stdout instead of file
--force, -f     Overwrite existing README.md
--badges        Include badges
--toc           Include table of contents
--help, -h      Show this help

Features

• 🚀 Zero dependencies, zero config
• 📦 Reads everything from package.json
• 🔍 Auto-detects CLI vs library packages
• 🏷️ Generates npm + GitHub badges
• 📋 Table of contents support

License

MIT © kszongic