accelint-readme-writer
OfficialAutomatically generate and refine READMEs.
Authorgohypergiant
Version1.0.0
Installs0
System Documentation
## What problem does it solve? README documentation often drifts out of sync with code. This skill analyzes the codebase from the README location and generates or updates a thorough, human-friendly README that reflects current functionality.
## Core Features & Use Cases
- Codebase-driven API mapping: Extracts public exports, types, and usage patterns to ensure the API section matches the actual code.
- Template-driven structure: Produces consistent READMEs with the prescribed sections (Heading Area, Installation, Quick Start, What, Why, API, Examples, License).
- Monorepo friendly: Scopes analysis to the package containing the README, enabling precise, package-level documentation.
### Quick Start Prompt the AI with "Document this package" or "Write a README for this package" to generate a complete README aligned with the codebase.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 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: accelint-readme-writer Download link: https://github.com/gohypergiant/agent-skills/archive/main.zip#accelint-readme-writer 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.