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

  1. Validate the project root and resolve the target README.md.
  2. Detect the repo profile from repo signals such as package metadata, CLI entrypoints, app/service manifests, or workspace files.
  3. In check-only, audit title/value proposition, common README sections, the required Overview > Motivation structure, and command integrity.
  4. In apply, keep edits bounded to the target README.md while repairing missing structure and grounded wording.
  5. Re-run the same audit to confirm post-fix status.
  6. If the repository is a skills or plugin repo with specialized install and discoverability conventions, use the dedicated maintain-skills-readme skill from /Users/galew/Workspace/agent-plugin-skills instead.
Related skills

More from gaelic-ghost/productivity-skills

Installs
3
GitHub Stars
1
First Seen
Mar 29, 2026