github-readme

github-readme is a skill for Claude Code, Codex from mickpletcher/AI-Skills. It costs 98 tokens per session (2,345 once invoked), scanned A, original, MIT.

A README writer for Mick's GitHub repositories. A README is the main instruction and overview page displayed in a code repository.

In plain words
What is it for?
Use it when creating or documenting one of Mick's repositories, including requests that begin with "readme" or "gr".
Why use it?
It helps create repository documentation in a consistent voice and layout. This reduces the work of turning a code project into a clearly explained repository.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it when creating or documenting one of Mick's repositories, including requests that begin with "readme" or "gr".

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/mickpletcher/ai-skills/github-readme
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.

Any agent
npx skills add mickpletcher/AI-Skills --skill github-readme
Clone the repo
git clone --depth 1 https://github.com/mickpletcher/AI-Skills

Made for: Claude Code, Codex.

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

README.md
[![agentmods](https://agentmods.dev/badge/skills/mickpletcher/ai-skills/github-readme/github.svg)](https://agentmods.dev/skills/mickpletcher/ai-skills/github-readme)
Your own site
<a href="https://agentmods.dev/skills/mickpletcher/ai-skills/github-readme"><img src="https://agentmods.dev/badge/skills/mickpletcher/ai-skills/github-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.

agentmods 80×15 button for github-readme

Your own site · 80×15
<a href="https://agentmods.dev/skills/mickpletcher/ai-skills/github-readme"><img src="https://agentmods.dev/badge/skills/mickpletcher/ai-skills/github-readme.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 98 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,345 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.00098 $0.02345
Opus 5.5 $0.00039 $0.00938
Sonnet 5.5 $0.00020 $0.00469
Haiku 4.5 $0.00010 $0.00234

Measured 1mo ago against content hash a872b64327a0, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

github-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 1mo 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/skills/github-readme/SKILL.md · 281 lines

How it starts

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

GitHub README Skill

Intent

Create or improve README files that accurately explain what a repo does, how to run it, and how a practical user should start.

Do Not Use When

  • Do not use when the user wants code implementation, PR review, repo architecture, or docs that are not tied to live repo behavior.
  • Required context is missing and cannot be reasonably inferred.
  • A more specific skill in this repo is a better match.

Constraints

  • Do not fabricate missing facts, measurements, dates, sources, or user context.
  • Keep output aligned with Mick's direct, practical communication style unless the skill says otherwise.
  • Preserve safety, legal, medical, financial, and operational boundaries stated in this file.
  • Prefer concise, usable output over broad explanation.

Validation Checklist

  • The output matches the skill's intended task and platform.
  • Required inputs, assumptions, and uncertainty are explicit.
  • Safety, scope, and source limits are respected.
  • The response follows the requested format or the skill's default output format.
  • The result is practical enough to use without another cleanup pass.

Write polished, complete README.md files for GitHub repositories in a direct, technical, practitioner-focused voice.

Primary Triggers

Use this skill when the user starts with readme or gr, or asks to write, rewrite, or document a repository README.

readme [paste repo description, file list, or context]
gr [GitHub URL or repo name + description]
write a readme
generate readme
readme for this repo
document this repo
rewrite my readme

Workflow

1. Identify the repo type

Choose the closest repo type before writing anything. That choice determines the section set.

Type Examples Typical Sections
Skills or config library Anthropic, PiHole blocklists Overview, contents table, install, repo structure, related repos
Code toolkit or multi-module repo AlpacaTrading, SafeSend Overview, what it does, feature table, repo structure, setup, env vars, usage by module, errors, license
Single script or utility PowerShell automation scripts Overview, what it does, prerequisites, usage, parameters, examples, license
MCP server homeassistant-mcp, pihole-mcp Overview, what it does, tools table, install and config, usage, notes, license
API integration or webhook SafeSend webhooks Overview, what it does, endpoint table, auth, payload schemas, setup, examples, license
Python application or CLI Trading bots, analyzers Overview, what it does, prerequisites, install with venv and requirements, usage, config, errors, license
Hybrid PowerShell and Python repo Trading Overview, what it does, structure split by language, setup per stack, usage by module, tests, license
Static site or website mickpletcher.com Overview, local preview, structure, deployment, content editing notes, license
Template or starter repo repo scaffolds Overview, what you get, how to use the template, customization points, license

Read the full file on GitHub · 281 lines

Files

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.

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. 1mo ago First seen · 281 lines · 98 tokens per session scan A a872b64327a0

Subscribe to this mod's changes

github-readme is a skill published in the GitHub repository mickpletcher/AI-Skills (20 stars, last pushed today), licensed MIT. It adds 98 tokens to every session and 2,345 once invoked, about $0.0004 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-08-30.

Related

Other skills, from other repositories

changelog-generator

Convierte un git log, lista de commits o notas de lanzamiento en un changelog pulido orientado al usuario. Usa cuando estés escribiendo notas de versión, generando una entrada en CHANGELOG.md o documentando qué cambió en una versión. Produce una sección de changelog estructurada con encabezado de versión, cambios…

mohitagw15856/pm-claude-skills · 96 tokens

pr-description-writer

Redacta una descripción de pull request clara y estructurada a partir de un diff de git, resumen de rama o lista de commits. Úsalo cuando te pidan escribir una descripción de PR, redactar una solicitud de cambios o documentar cambios de código. Produce una descripción con resumen, motivación, cambios realizados, pasos…

mohitagw15856/pm-claude-skills · 80 tokens

release-notes-from-git-log

Turn a git log into user-facing release notes grouped by feature and fix. Use when asked for release notes from this git log, a changelog entry from these commits, or to turn commits into release notes. Produces a grouped changelog with one line per change and a short headline.

mohitagw15856/pm-claude-skills · 66 tokens

releasing-godot-prompter

Use when cutting a GodotPrompter release or bumping its version — the version-bump sequence, tag-triggered workflow, and the marketplace manifests that must follow.

jame581/GodotPrompter · 44 tokens

epic-dev

Execute the project epic development workflow for Codex. Use when the user asks for "epic dev", "epic-dev", "/epic-dev", "run the epic workflow", "create an epic", "resume the epic", "--resume", "--next-phase", "--finalize", phased feature delivery, sprint phases, GitHub sub-issues, or git worktrees for multi-phase…

neuromechanist/research-skills · 84 tokens

workflow-reference

This skill should be used when executing the epic-dev workflow, creating epic branches, managing sprint phases, working with git worktrees for phased feature development, or when the user mentions "epic dev", "epic-dev", "/epic-dev", "epic workflow", "sprint phases", "phased development", or "git worktree workflow".

neuromechanist/research-skills · 75 tokens