Can it detect my existing project information?

Yes, it scans for manifest files like package.json, pyproject.toml, and Cargo.toml to pre-fill project names, versions, and primary languages as defaults.

Will it overwrite my existing README?

The skill explicitly checks for an existing README.md file and will warn you and seek confirmation before performing any overwrite.

What visual styles are available?

You can choose from 'Simple' (text-only), 'Centered' (clean layout with centered headers), or 'Styled' (professional layout with specific emoji icons for each section).

Can I choose which sections to include?

Yes, for Standard and Comprehensive depths, the skill interviews you to select specific sections like Features, Demo, API Reference, Roadmap, and FAQ.

Does it support monorepos or plugin sets?

Absolutely. It includes a specialized 'Plugin Collection' mode that auto-discovers sub-directories and generates a formatted directory table with version badges.

Professional README Generator

Name: Professional README Generator
Author: gupsammy

bygupsammy

•

学习与文档

Automates the creation of high-quality, professional README files by interviewing the developer and scanning project metadata.

The README Maker skill streamlines documentation by automatically detecting project context—including languages, versions, and dependencies—to generate tailored README.md files. Whether you need a minimal 50-line summary or a comprehensive 600-line guide for an open-source library, this skill conducts a structured interview to capture essential details, styles headings with emojis, integrates shields.io badges, and even auto-documents plugin collections or monorepos with component directory tables.

主要功能

01Three-tier depth selection (Minimal, Standard, Comprehensive) to match project scale and maturity.

0252 GitHub stars

03Specialized support for Plugin Collections and Monorepos with auto-discovered component tables.

04Automatic shield.io badge generation for licenses, CI/CD status, versions, and tech stacks.

05Context-aware scanning of manifest files like package.json and pyproject.toml to pre-fill project details.

06Customizable visual styles including Centered, Simple, and Emoji-styled heading layouts.

使用场景

01Quickly documenting a new internal utility or CLI tool with a functional, minimal README.

02Managing documentation for complex monorepos with multiple sub-packages or plugins.

03Creating polished, contributor-ready documentation for public open-source libraries.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add gupsammy/claudest make-readme

For use in Claude.ai and ChatGPT

Download Skill