github-readme

github-readme is a skill for Claude Code, Codex from thatrebeccarae/claude-marketing. It costs 63 tokens per session (2,965 once invoked), scanned A, original, MIT.

A guide for creating, checking, or updating GitHub README files, which explain what a software repository does and how to use it. It adapts the document to the project type and checks its quality, discoverability, and security.

In plain words
What is it for?
Use it to generate a README for a new repository, audit an existing one, or update it after changes to dependencies, features, or project structure.
Why use it?
It helps keep project documentation useful as a repository changes and makes important setup and usage information easier for people to find.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: reads .claude/ paths; mentions Claude Code.

Good fit Use it to generate a README for a new repository, audit an existing one, or update it after changes to dependencies, features, or project structure.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/thatrebeccarae/claude-marketing/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 thatrebeccarae/claude-marketing --skill github-readme
Clone the repo
git clone --depth 1 https://github.com/thatrebeccarae/claude-marketing

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/thatrebeccarae/claude-marketing/github-readme.svg)](https://agentmods.dev/skills/thatrebeccarae/claude-marketing/github-readme)
Your own site
<a href="https://agentmods.dev/skills/thatrebeccarae/claude-marketing/github-readme"><img src="https://agentmods.dev/badge/skills/thatrebeccarae/claude-marketing/github-readme.svg" alt="Measured on agentmods" height="20"></a>
Per session 63 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,965 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.00063 $0.02965
Opus 5 $0.00032 $0.01483
Sonnet 5 $0.00013 $0.00593
Haiku 4.5 $0.00006 $0.00297

Measured 4d ago against content hash cc42f3d0f414, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-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 4d 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.

skills/github-readme/SKILL.md · 288 lines

How it starts

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

GitHub README Generator

Generate, audit, or update repository READMEs with project-type detection, voice calibration, discoverability guidance, and scored quality audits.

Install

git clone https://github.com/thatrebeccarae/claude-marketing.git && cp -r claude-marketing/skills/github-readme ~/.claude/skills/

When to Use

  • Starting a new public repo and need a solid README from scratch
  • Auditing an existing README for quality, discoverability, and security issues
  • Updating a README after the repo has evolved (new deps, features, structure)
  • Preparing a repo for public release and want discoverability optimized

Modes

/github:readme generate [repo-path]   # Scan repo, detect type, generate README
/github:readme audit [repo-path]      # Score existing README (read-only, 0-100)
/github:readme update [repo-path]     # Re-scan, silent audit, patch with approval

Default repo-path is the current working directory if omitted.


Step 0: Parse and Validate

Expect: /github:readme {mode} [repo-path]

  1. Extract modegenerate, audit, or update. Any other value or missing → error with usage hint. STOP.
  2. Extract repo-path — second argument, or current working directory if omitted.
  3. Validate — confirm path exists, is a directory, and contains .git. If not → error. STOP.

Store repo_path (absolute) and mode.


Step 1: Scan the Repo

Gather context by reading available files. Skip gracefully if a file does not exist.

Package/config files (tech stack detection):

  • package.json — Node/TypeScript/React
  • Cargo.toml — Rust
  • pyproject.toml, setup.py, requirements.txt — Python
  • go.mod — Go
  • tsconfig.json — TypeScript confirmation
  • Dockerfile, docker-compose.yml — containerization
  • Makefile, justfile — build system
  • .github/workflows/ — CI/CD

Directory structure:

  • Run ls at repo root for top-level layout
  • Note: src/, bin/, lib/, scripts/, docs/, tests/, skills/, templates/, plugins/, .github/

Read the full file on GitHub · 288 lines

Files

What ships with it

3 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. 4d ago First seen · 288 lines · 63 tokens per session scan A cc42f3d0f414

Subscribe to this mod's changes

github-readme is a skill published in the GitHub repository thatrebeccarae/claude-marketing (132 stars, last pushed 3mo ago), licensed MIT. It adds 63 tokens to every session and 2,965 once invoked, about $0.0003 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-09-03.