README Gen

Generate beautiful README.md files with badges, install instructions, and API docs. Use when starting new projects.

How to load & run skills

README.md

Rendered from GitHub raw

On this page

ai-readme

Generate beautiful README.md files with badges, install instructions, usage examples, and API docs.

npm install -g ai-readme

npx ai-readme
# Reads package.json + source files, generates README.md
 
npx ai-readme ./my-project -o DOCS.md
# Custom directory and output file

export OPENAI_API_KEY=sk-...