readme

A command that reviews and rewrites a project's README, the main guide shown to people visiting the repository.

In plain words
What is it for?
Use it to assess a README, inspect related project files, and produce a clearer version for prospective users and contributors.
Why use it?
It helps make the project's purpose, benefits, and usage clear when the existing README is confusing or unconvincing.

Command for Claude Code

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 commands/sanmak/specops/readme
Clone the repo
git clone --depth 1 https://github.com/sanmak/specops

Made for: Claude Code.

Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,677 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.01677
Opus 5 $0.00000 $0.00839
Sonnet 5 $0.00000 $0.00335
Haiku 4.5 $0.00000 $0.00168

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

Security

Grade A, and why

readme 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.

.claude/commands/readme.md · 151 lines

How it starts

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

Audit and rewrite a project README for maximum clarity, value proposition, and developer conversion, using principles from Steve Jobs, David Ogilvy, Seth Godin, Simon Sinek, Paul Graham, George Orwell, and Jeff Bezos.

Instructions

Follow these steps precisely. This command evaluates a README against 8 dimensions drawn from marketing, writing, and open-source best practices, then generates a rewritten version optimized for the "star-or-bounce" moment.

Step 1: Read current README

Read README.md in the project root. If none exists, note "No README found" and switch to create mode (skip the scorecard, go directly to Step 4).

Also read any available project context: package.json, pyproject.toml, Cargo.toml, CLAUDE.md, or similar config files that reveal what the project does, its dependencies, and its target audience.

Step 2: Score against the README scorecard

Evaluate the current README on 8 dimensions. Each dimension is informed by a specific leader or pattern:

  1. Hook (Steve Jobs, David Ogilvy): Does the first visible line name a problem or benefit? Not a feature description, not "A framework for X." The headline does 80% of the work. One big idea, not ten features.

  2. Tagline (Steve Jobs): Is there a single sentence under 10 words that captures the core value? "1000 songs in your pocket" not "5GB hard drive with FireWire."

  3. Problem statement (Simon Sinek): Does it articulate WHY this exists before WHAT it does? People don't care what you built until they feel the pain it solves. No product name in the first sentence of the problem.

  4. Proof (Seth Godin): Is there a before/after, demo, screenshot, dogfood section, or usage example? Claims cost nothing. Evidence costs credibility. If it's remarkable, show it.

  5. Getting started (Supabase/shadcn pattern): Can someone install and try it in under 5 minutes with 3 or fewer commands? If getting started requires reading docs first, it's too long.

  6. Scanability (Paul Graham, George Orwell): Short sentences, tables over paragraphs, no jargon in the first 200 words. Write like you talk. Cut every word that does not change the meaning. Never use a long word where a short one will do.

Read the full file on GitHub · 151 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. 2d ago First seen · 151 lines · 0 tokens per session scan A d77267551aac

Subscribe to this mod's changes

readme is a command published in the GitHub repository sanmak/specops (49 stars, last pushed 29d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 1,677 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.