readme-upgrade
OfficialElevate your project docs instantly.
AuthorRoxabi
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill addresses the common issue of inconsistent and incomplete project documentation by automatically auditing and upgrading READMEs, CONTRIBUTING.md, and plugin documentation against a standardized developer-tool pattern.
Core Features & Use Cases
- Automated Documentation Audit: Checks for essential sections like 'Why', 'Quick Start', 'How it works', and feature tables.
- Targeted Improvements: Fills gaps and strengthens weak sections without rewriting existing good content.
- Use Case: Run
/readme-upgradeon your project to ensure all documentation adheres to best practices, making it easier for new contributors to understand and use your project.
Quick Start
Run the readme-upgrade skill with the command /readme-upgrade to audit and improve all project documentation.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: readme-upgrade Download link: https://github.com/Roxabi/roxabi-plugins/archive/main.zip#readme-upgrade Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.