readme-generator

Generate a README by running the readme-generator against your project structure. It analyzes your codebase to create installation, usage, environment variables, and deployment sections automatically, then outputs a complete README.md file ready for review and customization.

Yes, readme-generator automatically documents environment variables by analyzing your project structure. It identifies configuration requirements and generates an env vars section with descriptions, preserving your existing styling while excluding sensitive values.

Auto-generated READMEs cover installation, usage, environment variables, API references, contributing guidelines, licenses, and badges. The Skill identifies relevant sections based on your project type and framework, creating a structured template with tech stack details across diverse package managers.

Yes, readme-generator handles diverse frameworks and package managers by analyzing project structure to detect your tech stack. It generates framework-specific installation and usage sections, then applies appropriate badges and templates for consistency across different project types.

Yes, readme-generator preserves existing styling and custom sections when updating a README. It analyzes your current documentation structure and intelligently refreshes outdated sections like installation, usage, and environment variables without overwriting your manual edits.

Yes, readme-generator automatically excludes sensitive data such as actual environment variable values from the generated README. It documents what env vars are required and their purpose without exposing keys or secrets.