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 d-o-hub/github-template-ai-agents --skill readme-best-practicesgit clone --depth 1 https://github.com/d-o-hub/github-template-ai-agentsWrote 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/d-o-hub/github-template-ai-agents/readme-best-practices)<a href="https://agentmods.dev/skills/d-o-hub/github-template-ai-agents/readme-best-practices"><img src="https://agentmods.dev/badge/skills/d-o-hub/github-template-ai-agents/readme-best-practices/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/d-o-hub/github-template-ai-agents/readme-best-practices"><img src="https://agentmods.dev/badge/skills/d-o-hub/github-template-ai-agents/readme-best-practices.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.00100 | $0.01648 |
| Opus 5 | $0.00050 | $0.00824 |
| Sonnet 5 | $0.00020 | $0.00330 |
| Haiku 4.5 | $0.00010 | $0.00165 |
Grade A, and why
readme-best-practices 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 9d 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 — 187 lines — stays where its author put it; the contents beside it link to each section on GitHub.
README Best Practices (2026)
This skill guides you through creating a best-practice GitHub README.md for 2026, including a custom SVG logo and shields.io badges.
When to Use
- User asks to "write a README", "improve README", "add badges", or "create a logo"
- User asks to analyze or audit an existing README.md
- User wants to make a repository more professional or discoverable
- User asks about GitHub documentation best practices
Step-by-step workflow
1. Analyze the repository
Before writing anything, gather context:
# Detect tech stack
cat package.json 2>/dev/null | head -20
cat Cargo.toml 2>/dev/null | head -20
cat pyproject.toml 2>/dev/null | head -20
ls -1
find . -name "*.md" -maxdepth 2
Identify:
- Primary language(s) and tech stack
- What the project does (one sentence)
- Key features (5-10 bullet points)
- Installation method(s)
- Whether a live demo/deployment exists
- License type
- CI/CD system (GitHub Actions workflows)
- Existing screenshots or assets
2. Create the SVG logo
See references/LOGO.md for the full logo creation guide.
Quick pattern:
- ViewBox:
0 0 320 80atwidth="320" - Dark background pill (
#0f172ato#1e293bgradient,rx="14") - Domain-specific icon on the left
- Project acronym in indigo→cyan gradient (
#6366f1to#06b6d4) - Thin divider line below acronym
- Full project name as subtitle (
#94a3b8) - Tech stack chips on the right (colored pills)
- Save to:
assets/logo.svg - Reference:
<img src="assets/logo.svg" alt="..." width="320"/>in README
Use the template at assets/logo-template.svg as starting point.
3. Write README sections (in order)
Follow this exact section order:
1. <div align="center"> header block
- Logo image
- Project title (h1)
- One-line tagline (bold) + secondary sentence
- Shields.io badge row (CI | Release | License | Languages | Demo)
- Navigation links: Demo · Docs · Report Bug · Request Feature
2. "Why [project]?" — 3-4 value-proposition bullets
3. Table of Contents (for READMEs > 100 lines)
4. Quick Start — copy-paste, zero-config first
5. Architecture — ASCII or Mermaid diagram if applicable
6. Features — table: Feature | Description
7. Installation — per interface/language with fenced code blocks
8. Configuration — env vars table: Variable | Required | Default | Notes
9. Usage — per interface with realistic, runnable examples
10. Testing — unit, integration, e2e commands
11. Repository Structure — annotated tree
12. Contributing — numbered steps
13. License
What ships with it
6 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.
- 9d ago First seen · 187 lines · 100 tokens per session scan A 8cc8edc38112
readme-best-practices is a skill published in the GitHub repository d-o-hub/github-template-ai-agents (2 stars, last pushed yesterday), licensed MIT. It adds 100 tokens to every session and 1,648 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
skill-builder
Automatically detect source types and build AI skills using Skill Seekers. Use when the user wants to create skills from documentation, repos, PDFs, videos, or other knowledge sources.
skill-builder
Automatically detect source types and build AI skills using Skill Seekers. Use when the user wants to create skills from documentation, repos, PDFs, videos, or other knowledge sources.
write-readme
Generates or updates a README.md for a project or package. Reads the source code to understand the project and produces a clear, accurate README following the project's conventions. Invoked when the user asks to write, update, or generate a README.
bricks-builder
Research, implement, modify, and audit behavior inside Bricks Builder sites using the bundled Bricks Academy corpus, stable development workflows, and version-aware verification against an authorized active Bricks installation. Use when the requested outcome concerns Bricks elements, controls, schema, hooks…
write-changelog
Generates a CHANGELOG.md entry for a release by summarizing git commits since the last tag. Groups changes by type: Added, Changed, Fixed, Removed. Follows Keep a Changelog format (https://keepachangelog.com). Invoked when the user asks to update the changelog, write release notes, or prepare a release.
book-to-skill
Book-to-skill takes technical books, documentation, or other long-form sources and converts them into a skill made of a core definition plus per-chapter files, a glossary, and cheatsheets, so an agent can load only the relevant section instead of the whole document. It supports PDF, EPUB, DOCX, HTML, and several other…