repo-readme

What problem does it solve?

This Skill automates the process of creating a standardized README and documentation for repositories, improving readability, organization, and discoverability.

Core Features & Use Cases

• README Standardization: Ensures READMEs adhere to a specific format with required diagrams and information.
• Documentation Structure: Creates a hub-and-spoke documentation structure with a skimmable README and detailed content in separate directories.
• Use Case: When you want to ensure that your repository's README and documentation are clear, organized, and adhere to a consistent style, this Skill can be used to automatically generate or update these documents.

Quick Start

Run the repo-readme skill in your repository to automatically generate a standardized README and documentation.