readme-update

readme-update is a skill for Claude Code, Codex from KieranGao/general-readme-skill. It costs 126 tokens per session (2,964 once invoked), scanned A, original, MIT.

A workflow for updating existing README files after code changes, including translated editions. It checks the target version before editing and compares the README with the repository's current code.

In plain words
What is it for?
Use it to synchronize README content with Git changes, update multiple language editions, and perform a read-only preflight when the version still needs confirmation.
Why use it?
It prevents documentation from describing old behavior or silently changing the project's version. It also avoids replacing a carefully maintained README unnecessarily.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it to synchronize README content with Git changes, update multiple language editions, and perform a read-only preflight when the version still needs confirmation.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/kierangao/general-readme-skill/readme-update-skill
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add KieranGao/general-readme-skill --skill readme-update-skill
Clone the repo
git clone --depth 1 https://github.com/KieranGao/general-readme-skill

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for readme-update

README.md
[![agentmods](https://agentmods.dev/badge/skills/kierangao/general-readme-skill/readme-update-skill/github.svg)](https://agentmods.dev/skills/kierangao/general-readme-skill/readme-update-skill)
Your own site
<a href="https://agentmods.dev/skills/kierangao/general-readme-skill/readme-update-skill"><img src="https://agentmods.dev/badge/skills/kierangao/general-readme-skill/readme-update-skill/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for readme-update

Your own site · 80×15
<a href="https://agentmods.dev/skills/kierangao/general-readme-skill/readme-update-skill"><img src="https://agentmods.dev/badge/skills/kierangao/general-readme-skill/readme-update-skill.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 126 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,964 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00126 $0.02964
Opus 5.5 $0.00050 $0.01186
Sonnet 5.5 $0.00025 $0.00593
Haiku 4.5 $0.00013 $0.00296

Measured 9d ago against content hash c9e47824969e, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

readme-update scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 9d ago.

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/git_readme_delta.py), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

side-skills/readme-update-skill/SKILL.md · 113 lines

How it starts

The opening of the file, as written. The whole thing — 113 lines — stays where its author put it; the contents beside it link to each section on GitHub.

README Update Side Skill

Maintain documentation after code changes; do not regenerate an entire README by default. Coordinate with the readme-write skill (source directory general-readme-skill) for evidence, writing, design and validation. Prefer this side skill for Git-driven updates; use the main skill for creation or explicit redesign.

Mandatory version gate

Before editing any README, ask what the updated project version should be, with a clear “keep unchanged” option. Stop and wait unless the current request already supplies an exact version or explicitly says the version is unchanged. General delegation (“you decide”, “use defaults”, --yes) does not waive this gate and does not authorize inferring a bump from commits/tags.

Allow a read-only preflight before asking: locate the project Git root, discover README editions, and inspect public version fields in manifests/current README. Never confuse the installed skill version with the target project's version. Keep version observations as candidates with source paths; if they disagree, show the disagreement instead of silently choosing one. Do not read real secrets or personal author/email history.

Ask in the user's language, for example:

更新后的项目版本是多少?检测到 package.json 为 1.4.2,README 为 1.4.1。可回复一个版本(如 1.5.0),或“版本不变”。默认只更新 README 中的项目版本说明,保留现有排版,并同步全部语言版本;不会改包清单或创建 Git 标签。

If no version is detected, still offer an exact version or “不新增/不改变版本”. If the user requested a version-change scope beyond README, resolve affected packages/manifests/lockfiles explicitly rather than guessing. Read references/version-and-language-sync.md before proceeding.

Record the actual user decision internally: version_action=set|keep, target_version for set, version_scope=readme by default. Never fabricate a decision record. An unanswered question is not consent. In non-interactive execution return VERSION_REQUIRED; under context loss recover the actual reply or reconfirm. Read-only reviews and explicitly scoped link/typo repairs do not require a release-version question.

Read the full file on GitHub · 113 lines

Files

What ships with it

5 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 9d ago First seen · 113 lines · 126 tokens per session scan A c9e47824969e

Subscribe to this mod's changes

readme-update is a skill published in the GitHub repository KieranGao/general-readme-skill (63 stars, last pushed 10d ago), licensed MIT. It adds 126 tokens to every session and 2,964 once invoked, about $0.0005 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-10-07.

Related

Other skills, from other repositories

git-worktree

Use this skill whenever a task involves running parallel work on a git repository without conflicts — e.g. "fix this bug while I keep working on my feature", "run Claude on two branches at once", "work on this task in isolation", "create a throwaway branch for this experiment", or anything where two agents or sessions…

siva01c/claude-plugins · 132 tokens

app-release

Automates the release process for Skill Lake app, including version bumping, building, packaging, and publishing to GitHub and Homebrew.

emlog/skill-lake · 31 tokens

git-phase-restore

Autonomous Git-based project phase restoration. Uses Git history (commits, tags, branches, diffs, semantic messages) to identify and restore any development phase automatically. Trigger for: "restore to when X worked", "go back to before Y broke", "show project phases", "undo the last feature", "roll back to [phase]"…

mahmoud20138/Tradecraft · 165 tokens

datalad

Retrieves, versions, and publishes scientific datasets with DataLad and git-annex, and captures computational provenance with datalad run, rerun, and containers-run. Use when cloning or fetching data from OpenNeuro, DANDI, datasets.datalad.org, or any DataLad dataset; when a file in a dataset reads as a broken symlink…

K-Dense-AI/scientific-agent-skills · 147 tokens

pr-squash-message

Generate one short Conventional Commits squash message describing only the net diff between the PR's base and head, set its header as the PR title, validate it with the repository's commitlint and both copy its description to the clipboard and display it, when asked for a squash message. Works in any Scenario…

scenario-labs/skills · 73 tokens

git-workflow

A guide for handling Git repository work safely, including status checks, branches, commits, pushes, pull requests, and rebasing. Git is a version-control system that records code changes and coordinates work between developers.

laolaoshiren/claude-code-skills-zh · 73 tokens