readme-rule

A rule for writing README.md files in a technically accurate, approachable, and engaging style. A README is the main guide that explains a project to its users or contributors.

In plain words
What is it for?
Use it whenever creating or updating a project's README.md file.
Why use it?
It gives README writing a consistent tone while keeping the technical information correct.

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/asunyliu/practiceai/readme-rule
Clone the repo
git clone --depth 1 https://github.com/asunYLiu/practiceAI

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 53 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.00053
Opus 5 $0.00000 $0.00026
Sonnet 5 $0.00000 $0.00011
Haiku 4.5 $0.00000 $0.00005

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

Security

Grade A, and why

readme-rule 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 2d ago.

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-rule.mdc · 9 lines

What it actually says

README.md Rules

  • When you create README.md's - they should be dope, and use fun and approachable language.
  • While being fun, they should remain technically accurate.
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. 2d ago First seen · 9 lines · 53 tokens per session scan A afae57f5344f

Subscribe to this mod's changes

readme-rule is a cursor rule published in the GitHub repository asunYLiu/practiceAI (2 stars, last pushed 1y ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 53 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-08-31.