readme-conventions

readme-conventions is a cursor rule for Cursor from gifflet/cursor-like-pro. It costs 0 tokens per session (733 once invoked), scanned A, original, MIT.

A set of rules for keeping a project's README.md and Cursor-specific documentation consistent, clear, and written in English.

In plain words
What is it for?
Use it when writing or reviewing README files, documenting Cursor rules, adding project guidance, or standardizing documentation contributions.
Why use it?
It removes uncertainty about where documentation belongs and what sections, language, and links the README should contain.

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/gifflet/cursor-like-pro/readme-conventions
Clone the repo
git clone --depth 1 https://github.com/gifflet/cursor-like-pro

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-conventions

README.md
[![agentmods](https://agentmods.dev/badge/rules/gifflet/cursor-like-pro/readme-conventions.svg)](https://agentmods.dev/rules/gifflet/cursor-like-pro/readme-conventions)
Your own site
<a href="https://agentmods.dev/rules/gifflet/cursor-like-pro/readme-conventions"><img src="https://agentmods.dev/badge/rules/gifflet/cursor-like-pro/readme-conventions.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 733 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.00733
Opus 5 $0.00000 $0.00367
Sonnet 5 $0.00000 $0.00147
Haiku 4.5 $0.00000 $0.00073

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

Security

Grade A, and why

readme-conventions 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 4d 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-conventions.mdc · 133 lines

How it starts

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

README Conventions and Guidelines 📚

The project's README.md follows specific conventions to maintain consistency and clarity. The documentation is split between README.md (project overview) and CURSOR_TIPS.md (Cursor-specific documentation).

Language Requirements

All documentation MUST be written in English. This includes:

  • Main content
  • Comments
  • Examples
  • Section headers
  • File names and paths

README.md Structure

  1. Title and Introduction

    # Project Title 🚀
    
    Brief description of what the project does and its main benefits.
    
  2. Content Overview

    ## 📚 What You'll Find Here
    
    ### [CURSOR_TIPS.md](mdc:CURSOR_TIPS.md)
    Brief description of what's in CURSOR_TIPS.md
    
  3. Rules Section

    ## 📋 Rules
    
    Brief explanation of Cursor rules and their purpose.
    
    | Rule Name | Purpose | Description |
    |-----------|---------|-------------|
    | [rule-name](mdc:.cursor/rules/rule-name.mdc) | Category | Description |
    
  4. Contributing Section

    ## 🤝 Contributing
    
    How others can contribute to the project
    
  5. License Section

    ## 📝 License
    
    License information and terms
    

Content Guidelines

  1. General Principles

    • Keep README.md focused on project overview
    • Move Cursor-specific content to CURSOR_TIPS.md
    • Use clear, professional English
    • Be concise and direct
  2. Formatting

    • Use bold for emphasis
    • Use code for technical terms
    • Use emojis frgaUse horizontal rules (---) between main sections
  3. Links and References

    • Link to CURSOR_TIPS.md for Cursor-specific details
    • Link to rule files in .cursor/rules/
    • Use descriptive link text
    • Example:
    [Cursor Usage Guide](mdc:CURSOR_TIPS.md) | [Git Conventions](mdc:.cursor/rules/git-conventions.mdc)
    

Examples

✅ Good README Structure:

# Project Name 🚀

This project helps developers maximize productivity with Cursor IDE.

## 📚 What You'll Find Here

### [CURSOR_TIPS.md](mdc:CURSOR_TIPS.md)
Comprehensive guide for professional Cursor usage, including:
- Initial setup
- Project customization
- Advanced features

## 📋 Rules

Rules help maintain consistency across the project...

| Rule Name | Purpose | Description |
|-----------|---------|-------------|
| [git-conventions](mdc:.cursor/rules/git-conventions.mdc) | Git Standards | Enforces commit format... |

Read the full file on GitHub · 133 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. 4d ago First seen · 133 lines · 0 tokens per session scan A 0499dad4aa85

Subscribe to this mod's changes

readme-conventions is a cursor rule published in the GitHub repository gifflet/cursor-like-pro (17 stars, last pushed 1y ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 733 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-30.