maintain-project-readme
Installation
SKILL.md
Maintain Project README
Maintain ordinary software-project README.md files through one deterministic README workflow.
Inputs
- Required:
--project-root <path> - Required:
--run-mode <check-only|apply> - Optional:
--readme-path <path>
Workflow
- Validate the project root and resolve the target
README.md. - Detect the repo profile from repo signals such as package metadata, CLI entrypoints, app/service manifests, or workspace files.
- In
check-only, audit title/value proposition, common README sections, the requiredOverview > Motivationstructure, and command integrity. - In
apply, keep edits bounded to the targetREADME.mdwhile repairing missing structure and grounded wording. - Re-run the same audit to confirm post-fix status.
- If the repository is a skills or plugin repo with specialized install and discoverability conventions, use the dedicated
maintain-skills-readmeskill from/Users/galew/Workspace/agent-plugin-skillsinstead.