readme-maintainer
CommunityKeep READMEs accurate and up-to-date.
Authorsaadjs
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill automatically creates or updates README.md files to reflect the true state of a project by deriving content from verifiable sources in the repository. Use it when READMEs are missing, outdated, or require alignment with package configs, build/test scripts, environment examples, licenses, or changelogs.
Core Features & Use Cases
- Scan the repository for authoritative sources of truth (README.md, package manifests, lockfiles, env samples, licenses, and changelogs) and assemble a consistent documentation outline.
- Populate and update sections only when evidence exists, preserving existing content and avoiding guessing.
- Provide a clean, skimmable README that reflects the current project setup and contribution guidelines.
Quick Start
Run the readme-maintainer on a repository to generate or refresh the README.md using verified sources.
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-maintainer Download link: https://github.com/saadjs/agent-skills/archive/main.zip#readme-maintainer 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.