skills.rest
cuiguojie
cuiguojieCOMMUNITY
Explore all skills by this author →
Website𝕏@cuiguojieGitHub

generate-readme

Generate a tree-structured Markdown README from marketplace and plugin metadata.

Updated Dec 22, 2025
Search Tags:#automation#documentation#markdown#readme#plugins#marketplace
One-click install
npx skills add https://github.com/cuiguojie/my-claude-marketplace --skill generate-readme
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: generate-readme
Source: https://github.com/cuiguojie/my-claude-marketplace/tree/main/.claude/skills/generate-readme
Command: npx skills add https://github.com/cuiguojie/my-claude-marketplace --skill generate-readme

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automatically scans marketplace data and plugin metadata to generate a concise README.md for the project, keeping documentation up-to-date with minimal effort.

Core Features & Use Cases

  • Marketplace Scan: Read marketplace.json to discover plugins.
  • Plugin Metadata: Extracts name and description from plugin.json.
  • README Assembly: Collates tool names and descriptions into a structured README.

Quick Start

Run the skill to regenerate the project's README by scanning all plugins and their tools.

Frequently Asked Questions about generate-readme

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate a README from my marketplace plugins?▼

README generation scans marketplace.json to discover plugins, reads plugin.json for metadata, and extracts tool names and descriptions from plugin directories, collating them into a structured Markdown document that reflects your marketplace organization without manual updates.

What does the skill extract from plugins to build the README?▼

The skill extracts plugin names and descriptions from plugin.json, scans directories for skills, subagents, and MCPs, then pulls tool names and descriptions from SKILL.md frontmatter using a configurable limit parameter to keep output concise.

Can I keep my README synchronized with marketplace changes?▼

Yes, re-running the skill rescans all plugins and tools in your marketplace, regenerating the README to reflect current marketplace structure and tool metadata, eliminating manual documentation drift.

Does the generated README include version numbers or author information?▼

No, the README contains only names and descriptions organized in a tree structure showing marketplace to plugin to tool relationships, omitting versions and authors to keep documentation clean and readable.

What input files does the skill require to generate a README?▼

The skill requires marketplace.json listing available plugins, plugin.json files within each plugin containing name and description, and SKILL.md files in tool directories with frontmatter containing tool names and descriptions.

Is there a way to limit how much tool information the skill reads?▼

Yes, a limit parameter controls how much frontmatter the skill reads from SKILL.md files, allowing you to constrain the README output and processing scope per tool.

Related Skills

Explore More Software Engineering Skills→
otrebuotrebu
4

plugin-creator

Scaffold Claude Code plugins with metadata and marketplace registration.

Community
Advanced
gittowergittower
413

full-release

Orchestrate a Git-based software release from version preparation to published verification.

Official
Advanced
martin-jancimartin-janci
3

marketplace-maintenance

Guide plugin creation, skill additions, version bumps, and registry updates.

Community
Intermediate
manifoldlogicmanifoldlogic

marketplace-manager

Automate Claude Code plugin marketplace operations and documentation synchronization.

Official
Intermediate