readme-md

readme-md is a cursor rule for coding agents from diegomarino/awesomic-cursor-rules. It costs 0 tokens per session (1,176 once invoked), scanned A, original, MIT.

Rules for writing README.md files, which are project documents that explain software to its users and contributors.

In plain words
What is it for?
Use them when creating or reviewing a project's README documentation.
Why use it?
They provide a consistent structure for explaining installation, usage, configuration, testing, contribution, and licensing.

Cursor rule

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/diegomarino/awesomic-cursor-rules/readme-md
Clone the repo
git clone --depth 1 https://github.com/diegomarino/awesomic-cursor-rules

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

README.md
[![agentmods](https://agentmods.dev/badge/rules/diegomarino/awesomic-cursor-rules/readme-md.svg)](https://agentmods.dev/rules/diegomarino/awesomic-cursor-rules/readme-md)
Your own site
<a href="https://agentmods.dev/rules/diegomarino/awesomic-cursor-rules/readme-md"><img src="https://agentmods.dev/badge/rules/diegomarino/awesomic-cursor-rules/readme-md.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 1,176 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.1 $0.00000 $0.01176
Opus 5 $0.00000 $0.00588
Sonnet 5 $0.00000 $0.00235
Haiku 4.5 $0.00000 $0.00118

Measured 5d ago against content hash 4803f11f3d4f, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-05, from the pricing page.

Security

Grade A, and why

readme-md 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 5d 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.

rules/readme-md.mdc · 278 lines

How it starts

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

README.md Standards

Basic Structure

required_sections:
  - Project Name and Description
  - Features
  - Installation
  - Usage
  - Configuration
  - Contributing
  - License

optional_sections:
  - Table of Contents
  - Prerequisites
  - Development Setup
  - Testing
  - Deployment
  - API Documentation
  - FAQ
  - Troubleshooting
  - Changelog
  - Acknowledgments

Section Guidelines

Project Header

# Project Name

[![Build Status](mdc:shield-url)](build-url)
[![Coverage](mdc:shield-url)](coverage-url)
[![License](mdc:shield-url)](license-url)

One-paragraph project description that explains the core purpose and functionality.

[Optional: Add a screenshot, logo, or demo gif]

Features Section

## Features

- **Core Feature One**: Brief description of the feature
- **Core Feature Two**: Brief description of the feature
  - Sub-feature 2.1
  - Sub-feature 2.2

Installation Section

## Installation

### Prerequisites
```yaml
format:
  - Tool/dependency name
  - Version requirements
  - Installation command
  - Verification command

Quick Start

# Single command installation
npm install my-package

# Or step by step
git clone https://github.com/user/repo
cd repo
npm install
npm start

### Usage Section
```markdown
## Usage

### Basic Example
```javascript
const package = require('package-name');
const result = package.mainFunction();

Common Use Cases

  1. Use Case One
  2. Use Case Two
  3. Use Case Three

### Configuration Section
```yaml
format:
  environment_variables:
    - name: VARIABLE_NAME
      description: What this variable does
      required: true/false
      default: default_value
      example: example_value

  configuration_files:
    - name: config.json
      description: Main configuration file
      location: /path/to/file
      format: JSON/YAML/etc

Content Guidelines

Writing Style

tone:
  - Professional but approachable
  - Clear and concise
  - Active voice
  - Present tense

formatting:
  - Use proper markdown syntax
  - Consistent heading levels
  - Code blocks with language specification
  - Lists for better readability

Read the full file on GitHub · 278 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. 5d ago First seen · 278 lines · 0 tokens per session scan A 4803f11f3d4f

Subscribe to this mod's changes

readme-md is a cursor rule published in the GitHub repository diegomarino/awesomic-cursor-rules (10 stars, last pushed 1y ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 1,176 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.