readme-standardization
OfficialStandardize READMEs for consistency.
Authorflext-sh
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill ensures all README.md files across the FLEXT ecosystem are consistent, well-structured, and contain accurate, up-to-date information, improving discoverability and maintainability.
Core Features & Use Cases
- Preamble Enforcement: Guarantees a standardized header with version and review dates.
- Section Validation: Checks for the presence of mandatory sections like Key Features, Installation, Usage, and Architecture.
- Link Verification: Ensures internal and external links adhere to project standards.
- Use Case: When developing a new component, use this Skill to automatically generate and validate its
README.mdagainst established project guidelines, ensuring it's ready for review.
Quick Start
Run make docs to standardize the README.md file in the current directory.
Dependency Matrix
Required Modules
None requiredComponents
scriptsreferences
💻 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-standardization Download link: https://github.com/flext-sh/flext/archive/main.zip#readme-standardization 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 471,000+ vetted skills library on demand.