Does it support multiple programming languages?

It is language-agnostic and identifies project types (like Next.js, Python, or Go) by analyzing file structures and package manager files to provide relevant installation and usage scripts.

Can I choose which sections to include in the documentation?

Yes, the workflow includes an interactive Step 3 where you can multi-select sections like API documentation, license, contributing guides, and more.

Will it expose my secret environment variables?

No. The skill is designed to document the required variable names and their purposes for configuration guides, but it explicitly excludes sensitive actual values from .env files.

Can this skill update existing README files?

Yes, the README Generator analyzes existing documentation and can update or add specific sections while attempting to preserve your current style and formatting.

README Generator

Name: README Generator
Author: physics91

byphysics91

Learning & Documentation

Automates the creation and maintenance of professional project documentation by analyzing source code and directory structures.

About

The README Generator skill streamlines the documentation process by automatically identifying project types, dependencies, and scripts to build comprehensive README.md files. It offers interactive selection for various sections—such as installation guides, API references, and environment variable tables—while providing multiple styling options from concise technical summaries to badge-heavy open-source templates. Whether bootstrapping a new repository or updating an existing one, this skill ensures your project documentation remains accurate, readable, and professional.

Key Features

Customizable templates for technical, concise, or open-source styles
Dynamic environment variable documentation and badge generation
Seamless preservation of existing README styles during updates
Automatic project analysis for tech stack and dependency detection
0 GitHub stars
Interactive section selection including usage, installation, and contributing guides

Use Cases

Generating standard documentation for newly initialized software projects
Updating outdated README files to reflect recent code changes and new dependencies
Creating professional open-source landing pages with badges and contribution guides

About

Key Features

Customizable templates for technical, concise, or open-source styles
Dynamic environment variable documentation and badge generation
Seamless preservation of existing README styles during updates
Automatic project analysis for tech stack and dependency detection
0 GitHub stars
Interactive section selection including usage, installation, and contributing guides

Use Cases

Generating standard documentation for newly initialized software projects
Updating outdated README files to reflect recent code changes and new dependencies
Creating professional open-source landing pages with badges and contribution guides