📘 README Generator

Professional READMEs from Reality, Not Hallucinations

Stop manually formatting documentation and wrestling with template headers. This skill automates the creation of polished, production-ready README files by deep-scanning your repository's actual structure and configuration files.

What it does

Unlike generic AI prompts that guess how your code works, this skill performs an environmental audit. It identifies your tech stack by inspecting manifests like package.json, pyproject.toml, go.mod, and Cargo.toml. It extracts real scripts, validates entry points, and maps dependencies to generate accurate installation and usage guides.

Key Features

• Multi-Language Support: Tailored documentation for Node/TypeScript, Python, Go, Rust, and Java environments.
• Safe Inspection: Uses --help flags and manifest parsing to find commands without modifying your code.
• Evidence-Based: Extract descriptions from docstrings and JSDocs rather than inventing project goals.
• Dynamic Badges: Automatically includes license, version, and language badges based on detected metadata.

Why use this skill?

It eliminates "documentation drift." By grounding the output in your source code's reality, it ensures that if a script isn't in your manifest, it isn't in your README. It provides a standardized, professional structure that makes any repo "onboarding-ready" in seconds.