Does it overwrite my manual changes?

No, by using the --update flag and specific preserve markers like , you can protect specific sections from being overwritten during the generation process.

Which languages and frameworks are supported?

The skill automatically detects metadata from Node.js (package.json), Python (pyproject.toml), Rust (Cargo.toml), Go (go.mod), and Java (pom.xml) to generate context-specific instructions.

How does ADR integration work?

The skill scans your docs/adr directory for markdown files, parses their status and titles from headings or frontmatter, and generates a formatted table in the Architecture section of your README.

Can I generate only specific parts of the README?

Yes, you can use the --sections argument to provide a comma-separated list of specific sections, such as 'installation,usage', to focus on certain parts of the documentation.

Automated README Generator

Name: Automated README Generator
Author: kbrockhoff

bykbrockhoff

0•

Learning & Documentation

Generates and maintains comprehensive, codebase-aware project documentation with automated section detection and ADR integration.

Automated README Generator is a specialized documentation tool for Claude Code that analyzes your entire repository—including package managers, source code, and architectural records—to create professional README.md files. It intelligently detects project types, CLI usage, API exports, and testing frameworks to populate relevant sections automatically. Its standout feature is the update mode, which uses preservation markers to keep manual edits intact while refreshing auto-generated content, ensuring your documentation evolves alongside your code without losing custom notes or specialized instructions.

Key Features

01Multi-language support for Node.js, Python, Rust, Go, and Java ecosystems

02Preservation markers to protect manual content during documentation updates

03Intelligent codebase analysis for automatic section detection (Usage, API, Testing, etc.)

04Selective section generation and custom output path configuration

050 GitHub stars

06Automatic Architectural Decision Record (ADR) discovery and linking

Use Cases

01Aggregating distributed architectural decisions into a centralized README architecture table.

02Synchronizing README content with codebase changes while preserving hand-written sections.

03Bootstrapping a new project with a standard, high-quality documentation structure based on existing code.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add kbrockhoff/brockhoff-tools-claude genreadme

For use in Claude.ai and ChatGPT

Download Skill