readme-maintenance-standards

readme-maintenance-standards is a cursor rule for Cursor from ivangrynenko/cursorrules. It costs 0 tokens per session (714 once invoked), scanned A, original, MIT.

A set of rules for keeping a project's README file accurate and complete.

In plain words
What is it for?
It checks that README sections cover available features, installation, usage, configuration, contribution, licensing, versions, and changes.
Why use it?
It reduces outdated setup instructions, broken file links, missing version details, and undocumented 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/ivangrynenko/cursorrules/readme-maintenance-standards
Clone the repo
git clone --depth 1 https://github.com/ivangrynenko/cursorrules

Made for: Cursor.

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-maintenance-standards

README.md
[![agentmods](https://agentmods.dev/badge/rules/ivangrynenko/cursorrules/readme-maintenance-standards.svg)](https://agentmods.dev/rules/ivangrynenko/cursorrules/readme-maintenance-standards)
Your own site
<a href="https://agentmods.dev/rules/ivangrynenko/cursorrules/readme-maintenance-standards"><img src="https://agentmods.dev/badge/rules/ivangrynenko/cursorrules/readme-maintenance-standards.svg" alt="Measured on agentmods" height="20"></a>
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 714 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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 $0.00000 $0.00714
Opus 5 $0.00000 $0.00357
Sonnet 5 $0.00000 $0.00143
Haiku 4.5 $0.00000 $0.00071

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

Security

Grade A, and why

readme-maintenance-standards 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.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

.cursor/rules/readme-maintenance-standards.mdc · 70 lines

What it actually says

Enhanced README Maintenance Standards

Ensures that README files are consistently maintained, up-to-date, and informative.

actions:

  • type: enforce conditions:

    • pattern: "## (Available Rules|Features|Components)" message: "Update the 'Available Rules/Features/Components' section whenever new elements are added."

    • pattern: "\[[^]+`\]\([^)]+\)" message: "Ensure all file references in the README are properly linked and point to existing files."

    • pattern: "## (Installation|Usage|Configuration)" message: "Keep setup, usage, and configuration sections current with the latest project changes."

    • pattern: "## (Contributing|License)" message: "Ensure contributing guidelines and license information are accurate and up-to-date."

    • pattern: "\[Version\s*(\d+\.)?(\d+\.)?\d+\]" message: "Update version information to reflect the current state of the project."

    • pattern: "## (Changelog|Changes|Updates)" message: "Maintain a changelog for significant updates, fixes, and features."

  • type: suggest message: | README Maintenance Best Practices:

    • Rule Listings: Automatically update or manually check if new rules or features are reflected in the README.
    • Installation & Configuration: Regularly review and update installation and configuration instructions to match the latest project state.
    • Documentation of Changes: Document new features, bug fixes, and changes in a changelog or dedicated section.
    • Section Hierarchy: Maintain a logical structure with clear headings for easy navigation.
    • Examples: Include or update examples for new or changed functionalities.
    • Version Information: Keep version numbers and release notes current, linking to the changelog if applicable.
    • Table of Contents: Ensure the table of contents reflects the current document structure, using auto-generated if possible.
    • Badges: Update badges for CI/CD status, test coverage, or dependencies to reflect current project health.
    • Accessibility: Write with accessibility in mind, using alt text for images and semantic markdown.
  • type: validate conditions:

    • pattern: "^# [^\n]+\n\n## " message: "Ensure proper markdown heading hierarchy for readability."

    • pattern: "\|[^|]+\|[^|]+\|\n\|\s*-+\s*\|" message: "Use consistent table formatting throughout the document."

    • pattern: "\[(.*?)\]\((?!http|\/)[^\)]+\)" message: "All local links should point to existing files or sections within the project."

    • pattern: "\[Version\s*(\d+\.)?(\d+\.)?\*\d+\]" message: "Check that version placeholders are updated to actual numbers before release."

metadata: priority: high version: 1.1

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 · 70 lines · 0 tokens per session scan A a73e217f1333

Subscribe to this mod's changes

readme-maintenance-standards is a cursor rule published in the GitHub repository ivangrynenko/cursorrules (88 stars, last pushed 10mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 714 tokens. 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-09-03.