readme

A project rule for keeping README.md—the main introductory document for a software project—accurate as the product changes. It covers feature descriptions, technologies used, startup instructions, links, and developer login details.

In plain words
What is it for?
Use it whenever user-facing features, the technology stack, development startup commands, URLs, project names, badges, or top-level documentation change.
Why use it?
It prevents the public project documentation from becoming misleading after features, tools, URLs, or setup steps change. Accurate introductory documentation helps visitors and coding agents understand and run the project.

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/vepo/issues/readme
Clone the repo
git clone --depth 1 https://github.com/vepo/issues

Made for: Cursor.

Per session 541 This file is loaded in full into every session.
When invoked 541 The same file — it is already loaded in full.
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.00541 $0.00541
Opus 5 $0.00270 $0.00270
Sonnet 5 $0.00108 $0.00108
Haiku 4.5 $0.00054 $0.00054

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

Security

Grade A, and why

readme 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/readme.mdc · 53 lines

How it starts

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

README maintenance

README.md is the public face of Issues — the first doc visitors and agents read. Keep it accurate whenever user-visible capabilities or onboarding change.

When to update README.md

Trigger Action in README
New user-facing feature shipped Add bullet under the correct Features subsection
Feature removed or renamed Update or remove the matching bullet
Tech stack change (framework, DB, auth) Update Tech stack table
Dev startup or URLs change Update Quick start commands and links
New dev persona in dev-import.sql Update dev login table
Project name or Sonar badges change Update title and badge URLs
New top-level doc agents should know Add row to Documentation table

What belongs in README vs other docs

README Elsewhere
One-line pitch, tech stack, quick start
Feature bullets (what the product does) feature-catalog.md for routes, roles, click paths
Doc index links Full detail in linked docs
Dev login table (summary) Full personas in feature-catalog

Do not duplicate route tables or API signatures in README — link to feature-catalog.md and ARCHITECTURE.md.

Feature bullet format

  • Group under existing subsections (Tickets & workflow, Projects & administration, Views & analytics, Notifications & email, Authentication) or add a new subsection if needed.
  • Start with bold term — short description.
  • Use domain language from domain-specification.md.

Finish checklist

Before marking a feature task done when behaviour is user-visible:

  1. Update feature-catalog.md (routes and steps).
  2. Update README Features section (capability bullet).
  3. Update domain-specification.md if vocabulary changed.

Read the full file on GitHub · 53 lines

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 · 53 lines · 541 tokens per session scan A 5439690476d7

Subscribe to this mod's changes

readme is a cursor rule published in the GitHub repository vepo/issues (8 stars, last pushed 1mo ago), licensed Apache-2.0. It adds 541 tokens to every session, about $0.0027 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.