keep-readme-updated

A project rule for keeping the README.md file—the main documentation file for a code project—current when relevant code changes are made.

In plain words
What is it for?
Updating README.md as part of code changes when the documentation is affected.
Why use it?
It reduces the chance that project instructions and usage notes become outdated after implementation changes.

Cursor rule for Cursor

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.

agentmods
npx agentmods add rules/rictorres/cursor-rules/keep-readme-updated
Clone the repo
git clone --depth 1 https://github.com/rictorres/cursor-rules

Made for: Cursor.

Per session 154 This file is loaded in full into every session.
When invoked 154 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin unknown 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 $0.00154 $0.00154
Opus 5 $0.00077 $0.00077
Sonnet 5 $0.00031 $0.00031
Haiku 4.5 $0.00015 $0.00015

Measured yesterday against content hash e8bbc6cd7aee, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

keep-readme-updated 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 yesterday.

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.

.cursor/rules/keep-readme-updated.mdc · 18 lines

The source is not reproduced here

No licence file

A repository with no LICENSE is all rights reserved by default, so the body is not copied here. The metadata, the measurements and the link are.

Read it on GitHub

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. yesterday First seen · 18 lines · 154 tokens per session scan A e8bbc6cd7aee

Subscribe to this mod's changes

keep-readme-updated is a cursor rule published in the GitHub repository rictorres/cursor-rules (2 stars, last pushed 5mo ago), with no licence file. It adds 154 tokens to every session, about $0.0008 per session on Opus 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-08-31.