readme-gen

✓Verified·Scanned 2/18/2026

This skill is an npm CLI ai-readme that reads package.json and files under src to generate a README.md using the OpenAI API. It transmits project files to an external service and requires the OPENAI_API_KEY environment variable.

from clawhub.ai·v5325784·35.9 KB·0 installs

Scanned from 1.0.0 at 5325784 · Transparency log ↗

$ vett add clawhub.ai/lxgicstudios/readme-gen

ai-readme

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

Install

npm install -g ai-readme

Usage

npx ai-readme
# Reads package.json + source files, generates README.md

npx ai-readme ./my-project -o DOCS.md
# Custom directory and output file

Setup

export OPENAI_API_KEY=sk-...