README Maintainer

VerifiedSafe

Keeps the repo's README.md aligned with actual repo contents. Proposes additive changes and avoids rewrites.

Sby Skills Guide Bot
DocumentationBeginner
7/27/2026
Claude CodeCursorCodex
#readme#documentation#repo-maintenance#diff-limited#in-place-edit

Recommended for

Automated summary

Keeps a repository's README.md aligned with what the repo actually contains, using additive edits capped at roughly 100 diff lines.

Strengths

  • Tight scope: only README.md is touched, no other files are modified and no new files are created
  • Prefers additive changes such as new sections over rewrites, and matches the existing README's tone
  • Stops with no edits when the README is already accurate, avoiding pointless diffs
  • Requires every addition to be grounded in the real repo contents rather than invented features

Limitations

  • Changes larger than about 100 diff lines are only reported in the final message, not applied
  • Reads just the top-level repo structure, so details buried in subdirectories may be missed
  • Does not deeply fact-check pre-existing README claims and never edits other documentation
When to use it

Use it after adding or removing notable files and directories, to quickly bring the README back in sync without a full rewrite.

When not to use it

Avoid it when you want a complete README rewrite, a structural overhaul, or detailed documentation of internal APIs.

Security analysis

Safe
Quality score82/100

The skill is purely documentation-oriented: it reads README.md and the top-level repo listing, then proposes in-place edits scoped strictly to README.md. There are no declared tools, no shell commands, no network calls, no credential handling, and explicit instructions not to create files or delete sections without reason. The only 'power' exercised is reading repo structure, which is benign read-only behavior.

No concerns found

How this analysis is made

Examples

Sync after adding a CLI
We just added a `cli/` directory with an entry point script. Update README.md so it reflects the current repo layout, but keep the diff small.
Check for drift
Compare README.md against the top-level files and directories in this repo and tell me whether it's still accurate — only edit it if something significant is missing.
Missing usage section
The README has no Usage or Development section even though the repo clearly supports both. Add what's justified by the repo contents, staying within ~100 lines of diff.

name: readme-maintainer description: Keep the repo's README.md aligned with the actual contents of the repo.

readme-maintainer

Version: 0.1.0 Source: tokenman library, skills/readme-maintainer/ (temporary — see skills/README.md)

Scope

Operates on README.md only. Does not read or modify other files.

Shape

In-place edit. Prefer additive changes (new sections) over rewrites. If the README already describes the repo accurately, stop without edits.

Size limit

Diff must be ≤ ~100 lines. If a bigger change is warranted, stop and surface the observation in your final message instead of making the edit.

Deterministic gate hints

  • Only README.md should appear in the diff.
  • No new files.
  • No deletions of entire top-level sections without an explicit reason.

Evaluator criteria (medium strictness)

  • Changes stay scoped to README.md.
  • Additions are factually grounded in other repo contents (do not invent features).
  • Tone is consistent with the existing README.

Typical token budget

~15 000 tokens per run (generator + evaluator combined).

Instructions

When invoked:

  1. Read README.md.
  2. Read the repo structure (top-level files and directories) to compare what's documented against what's present.
  3. If the README omits something significant (e.g. missing Usage, Install, or Development section that the repo clearly supports), propose an addition.
  4. If the README is already aligned with the repo, stop without edits and say so in your final message.
  5. Stay within the size limit. If you think a bigger change is needed, summarize the finding instead of making it.

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/readme-maintainer-ms2s7c9h/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/readme-maintainer-ms2s7c9h' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/readme-maintainer-ms2s7c9h/download' --output '.skill-downloads/readme-maintainer-ms2s7c9h/SKILL.md.part' && mv '.skill-downloads/readme-maintainer-ms2s7c9h/SKILL.md.part' '.skill-downloads/readme-maintainer-ms2s7c9h/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/readme-maintainer-ms2s7c9h/SKILL.md' && test -s '.skill-downloads/readme-maintainer-ms2s7c9h/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/readme-maintainer' && cp -R '.skill-downloads/readme-maintainer-ms2s7c9h' '.claude/skills/readme-maintainer'

Cursor
test -f '.skill-downloads/readme-maintainer-ms2s7c9h/SKILL.md' && test -s '.skill-downloads/readme-maintainer-ms2s7c9h/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/readme-maintainer' && cp -R '.skill-downloads/readme-maintainer-ms2s7c9h' '.cursor/skills/readme-maintainer'

Codex
test -f '.skill-downloads/readme-maintainer-ms2s7c9h/SKILL.md' && test -s '.skill-downloads/readme-maintainer-ms2s7c9h/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/readme-maintainer' && cp -R '.skill-downloads/readme-maintainer-ms2s7c9h' '.agents/skills/readme-maintainer'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/readme-maintainer-ms2s7c9h'

openskills read 'readme-maintainer-ms2s7c9h'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/readme-maintainer-ms2s7c9h/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills