Will I lose my existing README content?

No, the skill is designed to back up your existing README.md before generating a new version, allowing you to review or revert changes.

What is progressive disclosure in this context?

It uses HTML details tags to hide advanced configurations or long command lists, keeping the main README clean and beginner-friendly.

Does it handle visual elements like logos or GIFs?

It creates the markdown structure for visual elements and provides a checklist of recommended assets like banners and demo GIFs to complete the README.

How does it determine project details automatically?

The skill analyzes configuration files like package.json, pyproject.toml, and Cargo.toml to identify names, descriptions, and installation methods.

What project types does the README Builder support?

It includes specialized templates for CLI tools, Libraries/SDKs, Web Apps, and Plugins, ensuring the structure matches the project's purpose.

README Builder

Name: README Builder
Author: jrc1883

byjrc1883

Learning & Documentation

Generates professional, high-impact project documentation following 'awesome-readme' best practices through automated project analysis.

About

README Builder automates the creation of compelling documentation by analyzing your project structure and dependencies. It guides you through a brief interview to determine your target audience and visual preferences, then crafts a structured README featuring hero sections, progressive disclosure for advanced users, and auto-generated command lists. Whether you're launching a new CLI tool or refreshing an existing library, this skill ensures your documentation is scannable, visually appealing, and beginner-friendly.

Key Features

Progressive disclosure patterns using collapsible sections for depth
Pre-publication validation for links and installation commands
0 GitHub stars
Visual asset checklists for logos, banners, and functional demos
Tailored templates for CLI tools, libraries, web apps, and plugins
Automated project analysis to detect tech stacks and dependencies

Use Cases

Standardizing documentation structure across multiple team repositories
Launching a new open-source project with professional-grade documentation
Overhauling stale or overwhelming README files in legacy repositories

About

Key Features

Progressive disclosure patterns using collapsible sections for depth
Pre-publication validation for links and installation commands
0 GitHub stars
Visual asset checklists for logos, banners, and functional demos
Tailored templates for CLI tools, libraries, web apps, and plugins
Automated project analysis to detect tech stacks and dependencies

Use Cases

Standardizing documentation structure across multiple team repositories
Launching a new open-source project with professional-grade documentation
Overhauling stale or overwhelming README files in legacy repositories