How do I choose between different levels of detail?

You can use the --style parameter to choose between 'minimal' for quick overviews, 'standard' for most projects, and 'detailed' for complex software requiring architecture diagrams and API references.

What programming languages does this skill support?

It natively detects metadata for JavaScript/TypeScript, Python, Rust, and Go, with fallback logic for any project containing a git remote or license file.

Can I audit my README without making any changes?

Yes, by using the --check-only flag, the skill will generate a compliance report highlighting missing or partial sections without modifying your files.

Does it automatically include a project directory tree?

Yes, it uses an optimized tree command that excludes noise like node_modules, .git, and build artifacts to provide a clean overview of your project structure.

README Configurator

Name: README Configurator
Author: laurigates

bylaurigates

•

Learning & Documentation

Automates the creation and standardization of project README files with badges, tech stacks, and structured documentation.

The configure-readme skill is a specialized utility for Claude Code designed to streamline project documentation. It intelligently detects project metadata from various package managers—including npm, poetry, cargo, and go—to automatically generate or audit README.md files. By scanning for logo assets and building a professional structure with Shields.io badges, feature lists, and automated project tree visualizations, it ensures your repository meets modern documentation standards. Whether you're starting a new project from scratch or standardizing an existing codebase, this skill provides a consistent, high-quality documentation workflow.

Key Features

01Automated project structure generation using intelligent tree filtering

02Automated metadata extraction from JS, Python, Rust, and Go configuration files

03Section-by-section compliance reporting to identify missing documentation

04Dynamic Shields.io badge integration and logo asset detection

05Three distinct documentation styles: Minimal, Standard, and Detailed

0610 GitHub stars

Use Cases

01Standardizing README formats and sections across a large organization's codebase

02Auditing existing documentation for missing critical sections like installation, license, or features

03Initializing professional documentation for new open-source repositories

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add laurigates/claude-plugins configure-readme

For use in Claude.ai and ChatGPT

Download Skill