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 wahidyankf/ose-public --skill readme-writing-readme-filesgit clone --depth 1 https://github.com/wahidyankf/ose-publicWrote 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/wahidyankf/ose-public/readme-writing-readme-files)<a href="https://agentmods.dev/skills/wahidyankf/ose-public/readme-writing-readme-files"><img src="https://agentmods.dev/badge/skills/wahidyankf/ose-public/readme-writing-readme-files/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/wahidyankf/ose-public/readme-writing-readme-files"><img src="https://agentmods.dev/badge/skills/wahidyankf/ose-public/readme-writing-readme-files.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.00066 | $0.00780 |
| Opus 5.5 | $0.00026 | $0.00312 |
| Sonnet 5.5 | $0.00013 | $0.00156 |
| Haiku 4.5 | $0.00007 | $0.00078 |
Grade A, and why
readme-writing-readme-files 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.
How it starts
The opening of the file, as written. The whole thing — 88 lines — stays where its author put it; the contents beside it link to each section on GitHub.
Writing README Files
Purpose
This Skill provides comprehensive guidance for writing high-quality README files that are engaging, accessible, and scannable. READMEs serve as the entry point for repositories, projects, and directories, requiring special attention to clarity, structure, and user experience.
When to use this Skill:
- Creating repository README.md files
- Writing project/package README files
- Creating directory README files for navigation
- Updating existing READMEs for clarity
- Reviewing READMEs for quality standards
Core README Principles
See Core README Principles for the six principles (problem-solution hook, plain language, paragraph length, benefits-focused language, visual hierarchy, progressive disclosure) with ✅/❌ before/after examples.
Standard README Structure
See Standard README Structure for the full README template (Overview, Key Benefits, Quick Start, Installation, Usage, Documentation, Contributing, License).
Common Mistakes
❌ Mistake 1: Starting with features, not benefits
Wrong: Lists features without context Right: Shows problem, solution, and benefits first
❌ Mistake 2: Unexplained acronyms
Wrong: "Supports WCAG, ARIA, WAI" Right: "Supports WCAG (Web Content Accessibility Guidelines), ARIA (Accessible Rich Internet Applications), and WAI (Web Accessibility Initiative) standards"
❌ Mistake 3: Wall of text paragraphs
Wrong: 10+ line paragraphs that are hard to scan Right: Max 5 lines per paragraph, use lists and headings
❌ Mistake 4: Missing context for jargon
Wrong: "Uses Nx monorepo with affected builds" Right: "Uses Nx (a monorepo build system) to manage multiple apps. The 'affected' feature only rebuilds changed projects, saving time."
❌ Mistake 5: No quick start section
Wrong: Jumps directly into detailed installation Right: Provides "Quick Start" with minimal steps, then detailed installation
What ships with it
4 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.
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.
- 2d ago First seen · 88 lines · 66 tokens per session scan A 4114804ab256
readme-writing-readme-files is a skill published in the GitHub repository wahidyankf/ose-public (12 stars, last pushed today), licensed MIT. It adds 66 tokens to every session and 780 once invoked, about $0.0003 per session on Opus 5.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-10-14.
Other skills, from other repositories
gpu-document-processing
Use when processing large PDFs, document collections, or bulk text extraction tasks that benefit from GPU-accelerated processing. Triggers when the user provides large documents or needs bulk document analysis.
enrich-excel
Enrich a live Excel spreadsheet by researching missing data with TinyFish and writing results directly into the running Excel app via AppleScript. Use when a user says "fill in my spreadsheet", "enrich this Excel file", "research and fill missing data", "update my Excel sheet", "look up data for each row", or any…
azure-ai-document-intelligence-ts
Extract text, tables, and structured data from documents using Azure Document Intelligence (@azure-rest/ai-document-intelligence). Use when processing invoices, receipts, IDs, forms, or building cu...
nx-plugin-for-aws
Scaffold and build cloud-native applications on AWS using @aws/nx-plugin generators. Use when the user wants to create workspaces, generate projects, or scaffold infrastructure with the Nx Plugin for AWS.
document-parsing
Extract readable Markdown from local Word, PowerPoint, Excel, OpenDocument, RTF, EPUB, CSV, and text-based PDF files using the preinstalled AnyDoc runtime.
opengeni-documents
Create, inspect, edit, review, import, and export durable Opengeni document artifacts and explicit DOCX file boundaries. Use when creating or editing a document Artifact or DOCX (reports, briefs, proposals, forms, tables, sections, headers, footers, comments, tracked changes, and Word-compatible delivery); ordinary…