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.
npx skills add thuanvd378/write-me-a-readme --skill readmegit clone --depth 1 https://github.com/thuanvd378/write-me-a-readmeWrote 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.
[](https://agentmods.dev/skills/thuanvd378/write-me-a-readme/readme)<a href="https://agentmods.dev/skills/thuanvd378/write-me-a-readme/readme"><img src="https://agentmods.dev/badge/skills/thuanvd378/write-me-a-readme/readme/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/skills/thuanvd378/write-me-a-readme/readme"><img src="https://agentmods.dev/badge/skills/thuanvd378/write-me-a-readme/readme.svg" alt="Reviewed on agentmods" width="80" height="20"></a>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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.00103 | $0.02516 |
| Opus 5 | $0.00051 | $0.01258 |
| Sonnet 5 | $0.00021 | $0.00503 |
| Haiku 4.5 | $0.00010 | $0.00252 |
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 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.
How it starts
The opening of the file, as written. The whole thing — 159 lines — stays where its author put it; the contents beside it link to each section on GitHub.
Write Me a README
Create a trustworthy repository front page from project evidence. Write for a new visitor who must understand the value, verify the fit, and reach a working first result quickly.
Resolve every bundled path relative to this SKILL.md. Run scripts with the current Python interpreter; do not assume the skill is installed at a fixed global path.
Operating contract
- Produce or update
README.mdin the target project unless the user requests audit-only output. - Inspect before writing. Treat source files, manifests, tests, CI, examples, existing docs, and user statements as evidence in that order.
- Never invent commands, compatibility, performance, adoption, maintainers, security posture, or production readiness.
- Never copy prose, slogans, banners, or layouts from another repository. Learn patterns, then create original content and visuals.
- Preserve useful existing material, deliberate terminology, status warnings, legal notices, and user-authored sections.
- Keep source-code changes out of scope. Add only README-related files unless the user explicitly expands the task.
- Do not promise search ranking, GitHub Trending placement, virality, or adoption. Optimize discoverability, comprehension, conversion, and trust.
- Prefer a complete first pass over blocking questions. Ask only when a missing choice would materially change the result and cannot be inferred safely.
1. Establish scope
Infer these choices from the request and repository:
- Mode: create, refresh, redesign, translate, or audit-only.
- Audience: end user, library consumer, operator, contributor, learner, or mixed.
- Language: preserve the established README language; otherwise use the dominant project-doc language; otherwise default to English.
- Voice: honor an explicit style request; otherwise infer the established brand voice and default to confident-friendly. Use one primary profile plus at most one modifier, such as
professional + warmorplayful + concise. - Visuals: generate a banner for a new README by default. Keep an existing high-quality branded hero unless replacement is requested. Honor text-only requests.
- Depth: keep a small tool concise; move extensive concepts, API reference, and contributor internals to existing or new
docs/pages only when needed.
What ships with it
21 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.
- agents/openai.yaml 241 B
- assets/fonts/OFL.txt 4.3 KB
- assets/fonts/SpaceGrotesk-Variable.ttf 133 KB
- assets/presets/aurora.json 313 B
- assets/presets/candy.json 324 B
- assets/presets/daylight.json 315 B
- assets/presets/ember.json 318 B
- assets/presets/midnight.json 308 B
- assets/presets/paper.json 327 B
- references/asset-licensing.md 5.6 KB
- references/banner-design.md 7.2 KB
- references/quality-rubric.md 4.1 KB
- references/readme-patterns.md 10 KB
- references/research-sources.md 9.5 KB
- references/seo-discovery.md 4.0 KB
- references/voice-and-style.md 12 KB
- requirements.txt 17 B
- scripts/banner.py 50 KB runs code
- scripts/fetch_commons.py 34 KB runs code
- scripts/inspect_project.py 32 KB runs code
- scripts/validate_readme.py 35 KB runs code
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.
- 8d ago First seen · 159 lines · 103 tokens per session scan A ef0975e71e44
readme is a skill published in the GitHub repository thuanvd378/write-me-a-readme (1 stars, last pushed 1mo ago), licensed MIT. It adds 103 tokens to every session and 2,516 once invoked, about $0.0005 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.
Other skills, from other repositories
keep-the-why
Extract and preserve the reasoning code cannot explain - decisions, rejected alternatives, workarounds, incidents, constraints - plus project setup and maintainer interviews. Not for what changed (see Keep a Changelog) - only why.
diagrams
Mermaid diagrams following the C4 model: context, container, component, sequence, ER and deployment. Use when saying "diagram", "visualize", or "architecture diagram".
review
Adversarial fresh-context review of an increment before it ships. Every finding cites path:line and is re-verified. Use when saying "review", "grill this", or "critique the implementation".
sw-do
Implement a SpecWeave increment task by task through the ledger, with evidence per task and a verified close. Use for "implement this", "start working", "continue the increment", "keep going".
done
Close an increment: ledger check, specweave verify, optional review, then specweave complete. Use when all tasks are done and saying "close increment", "we are done", or "finish up".
pre-modification-check
Use before modifying, refactoring, moving, or deleting files in a Repowise-indexed repository, especially shared utilities, core modules, public APIs, or files the user did not explicitly identify.