Readme Gen

What it does

The readme-gen skill automates the creation of high-quality, professional README documentation by performing a deep analysis of your codebase. Instead of manually typing out folder structures or hunting for dependency versions, this skill reads your project manifests (like package.json, pyproject.toml, or cargo.toml) and source files to build a structured, accurate technical document.

How it works

The skill follows a multi-step discovery process to ensure accuracy:

• Metadata Extraction: Identifies project name, version, and license from system manifests.
• Stack Detection: Uses glob patterns to identify languages (TS, Python, Go, Rust) and frameworks (Next.js, Vite, Docker).
• API Mapping: Reads entry points to automatically document exported functions and classes.
• Environment Discovery: Detects required environment variables via .env fragments and documentation.

Why use this skill?

Writing documentation is often the last thing developers want to do. Setting up a high-level README manually is prone to getting outdated. Since this skill analyzes the actual code and file structure, it reflects the true state of your project. It’s significantly faster than manual prompting because it knows exactly which files to audit and how to format shields.io badges and script tables for a standard repository look.