readmes

A set of writing rules for Markdown README files, covering their wording, structure, headings, examples and formatting.

In plain words
What is it for?
Use it when creating or editing README files, especially to choose headings, organise instructions, add code examples and show command-line usage.
Why use it?
It removes guesswork about how README files should look and helps keep documentation brief, consistent and easy to copy from.

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/tantodefi/xmtpauth/readmes
Clone the repo
git clone --depth 1 https://github.com/tantodefi/xmtpauth

Made for: Cursor.

Per session 332 This file is loaded in full into every session.
When invoked 332 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.00332 $0.00332
Opus 5 $0.00166 $0.00166
Sonnet 5 $0.00066 $0.00066
Haiku 4.5 $0.00033 $0.00033

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

Security

Grade A, and why

readmes 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/readmes.mdc · 55 lines

What it actually says

globs: *.md alwaysApply: false

README Style Guide

README Writing Standards

When creating or editing README files, follow these strict guidelines:

Content Style

  • Sentence-style capitalization: Use sentence-style capitalization for headers
  • No emojis: Never use emojis in READMEs
  • Concise: Be brief and to the point
  • No redundancy: Avoid repeating information
  • Code-heavy: Prioritize code examples and snippets over lengthy explanations
  • Sentence-style capitalization: Use sentence-style capitalization for headers

Structure

  • Use clear, direct headers without decorative elements
  • Lead with practical examples rather than theory
  • Include minimal explanatory text - let code speak for itself
  • Focus on "how" rather than "why"

Format Requirements

  • Use plain text headers (no emoji prefixes)
  • Include more code blocks than paragraphs
  • Keep descriptions brief - one sentence when possible
  • Use tables for structured data without emoji indicators

Code Examples

  • Always include working code examples
  • Show real command line usage
  • Provide copy-paste ready snippets
  • Include minimal setup instructions

Performance Tables

  • Use text instead of emoji status indicators:
    • "On Target" instead of ✅
    • "Concern" instead of ⚠️
    • "Failed" instead of ❌
  • Keep table data clean and readable

Anti-patterns to Avoid

  • Emoji decorations in headers or content
  • Long explanatory paragraphs
  • Redundant information across sections
  • Flowery or marketing language
  • Over-explanation of simple concepts
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 · 55 lines · 332 tokens per session scan A f6ff99064923

Subscribe to this mod's changes

readmes is a cursor rule published in the GitHub repository tantodefi/xmtpauth (3 stars, last pushed 11mo ago), licensed MIT. It adds 332 tokens to every session, about $0.0017 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.