What problem does it solve?
This skill streamlines creating polished, consistent README.md files by enforcing a centered, table-based layout and shields.io badges, reducing manual formatting time and ensuring uniform documentation across Ghost projects and GitHub repositories.
Core Features & Use Cases
- Centered, table-driven READMEs: All major sections and content are organized in centered tables with markdown support.
- Badge-driven metadata: Generates shields.io badges with colors appropriate to tech stack and project type.
- Flexible templates: Provides static templates for different project types and a robust Quick Start guide for rapid adoption.
- Validation guidance: Includes guidelines to validate and adapt READMEs for accuracy and readability.
Use cases: generating READMEs for new Ghost projects, reformatting existing READMEs to the standard structure, documenting repository purpose and usage.
Quick Start
- Run the skill on a repository you want to document.
- Provide project title, short description, and key features and the skill will output a formatted README.