readme-md-guidelines

readme-md-guidelines is a cursor rule for Cursor from holtwood/awesome-cursorrules-zh. It costs 4 tokens per session (668 once invoked), scanned A, original, MIT.

A writing guide for the README.md file that documents a Laravel package. It covers the package overview, Composer installation, configuration, usage examples, testing, contributions, licensing, and optional change history.

In plain words
What is it for?
Use it to create or review documentation for a Laravel package, including installation commands, examples, configuration instructions, testing steps, and contribution guidance.
Why use it?
It prevents important setup and usage information from being scattered or omitted. Readers can more easily install the package and understand how to use it.

Cursor rule for Cursor

Written for Cursor: a Cursor rule (.mdc).

Good fit Use it to create or review documentation for a Laravel package, including installation commands, examples, configuration instructions, testing steps, and contribution guidance.

Compare 6 cursor rules from other repositories ↓
Install with agentmods
npx agentmods add rules/holtwood/awesome-cursorrules-zh/readme-md-guidelines
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.

Clone the repo
git clone --depth 1 https://github.com/holtwood/awesome-cursorrules-zh

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

README.md
[![agentmods](https://agentmods.dev/badge/rules/holtwood/awesome-cursorrules-zh/readme-md-guidelines.svg)](https://agentmods.dev/rules/holtwood/awesome-cursorrules-zh/readme-md-guidelines)
Your own site
<a href="https://agentmods.dev/rules/holtwood/awesome-cursorrules-zh/readme-md-guidelines"><img src="https://agentmods.dev/badge/rules/holtwood/awesome-cursorrules-zh/readme-md-guidelines.svg" alt="Measured on agentmods" height="20"></a>
Per session 4 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 668 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.00004 $0.00668
Opus 5 $0.00002 $0.00334
Sonnet 5 $0.00001 $0.00134
Haiku 4.5 $0.00000 $0.00067

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

Security

Grade A, and why

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

docs/rules/backend/php/laravel-package-guide/readme-md-guidelines.mdc · 91 lines

What it actually says

README.md 指南

本规则集定义了 Laravel 包开发中 README.md 文件的编写指南和最佳实践,旨在确保包文档的清晰性、完整性和易用性。

1. 标题与简介

  • 包名称: README.md 的顶部应包含清晰的包名称,通常作为一级标题。
  • 简短描述: 紧随其后应提供一个简短、吸引人的包功能描述,让读者快速了解其用途。
  • 状态徽章 (可选): 可以包含 CI/CD 状态、版本号、下载量等徽章,以提供快速概览。

2. 安装指南

  • Composer: 详细说明如何通过 Composer 安装包,包括 composer require 命令。
  • 服务提供者: 如果需要,说明如何在 config/app.php 中注册服务提供者。
  • 发布配置/迁移: 如果包包含可发布的文件(如配置文件、迁移文件),提供发布命令。

3. 使用方法

  • 基本用法: 提供清晰的代码示例,展示包的核心功能如何使用。
  • 高级用法 (可选): 如果包有更复杂或高级的功能,可以提供额外的示例。
  • 配置: 说明如何配置包,包括配置文件的结构和常用选项。

4. 贡献指南

  • 如何贡献: 简要说明如何为包贡献代码,例如提交 Bug 报告、功能请求或 Pull Request。
  • 代码风格: 如果有特定的代码风格要求,可以提及或链接到相关文档。

5. 测试

  • 运行测试: 说明如何运行包的测试。

6. 许可证

  • 许可证信息: 明确指出包的许可证类型(如 MIT、Apache 2.0),并建议包含许可证文件的链接。

7. 变更日志 (可选)

  • 版本历史: 可以包含一个指向 CHANGELOG.md 文件的链接,或直接在 README.md 中简要列出主要版本变更。

8. 示例结构

# Your Awesome Laravel Package

一个简短的描述,说明你的包做了什么。

[![Build Status](https://example.com/badge.svg)](https://example.com/ci)

## 安装

```bash
composer require vendor/package-name

发布配置 (可选)

php artisan vendor:publish --provider="Vendor\\PackageName\\PackageServiceProvider"

使用方法

// 你的代码示例

配置

说明配置选项。

贡献

欢迎贡献!请参阅 CONTRIBUTING.md 获取更多信息。

测试

composer test

许可证

本项目根据 MIT 许可证发布。

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. 8d ago First seen · 91 lines · 4 tokens per session scan A ca5a230e37c9

Subscribe to this mod's changes

readme-md-guidelines is a cursor rule published in the GitHub repository holtwood/awesome-cursorrules-zh (232 stars, last pushed 1mo ago), licensed MIT. It adds 4 tokens to every session and 668 once invoked, about $0.0000 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-30.