readme-generator

A tool for creating or improving a project's README.md, the guide that explains what the project does and how to use it.

In plain words
What is it for?
Writing project introductions, installation and quick-start instructions, usage examples, configuration tables, contribution guidance, badges, and license sections.
Why use it?
It grounds the documentation in the repository so setup commands, scripts, and project details are based on what is actually present.

Skill for Claude CodeCodex

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.

agentmods
npx agentmods add skills/jayrha/agentskills/readme-generator
Any agent
npx skills add JayRHa/AgentSkills --skill readme-generator
Clone the repo
git clone --depth 1 https://github.com/JayRHa/AgentSkills

Made for: Claude Code, Codex.

Per session 107 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,618 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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 $0.00107 $0.01618
Opus 5 $0.00053 $0.00809
Sonnet 5 $0.00021 $0.00324
Haiku 4.5 $0.00011 $0.00162

Measured 2d ago against content hash 252de3ef5c9b, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

readme-generator 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.

The scan reads SKILL.md. This mod also ships 2 executable files (scripts/detect_project.py, scripts/lint_readme.py), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

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.

readme-generator/SKILL.md · 150 lines

How it starts

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

README Generator

Overview

This skill produces a complete, polished README.md that serves as a project's front door. It inspects the repository to ground the content in reality (real install commands, real scripts, real entry points) rather than inventing details, then assembles the appropriate sections in a conventional, scannable order.

Keywords: readme, README.md, project documentation, badges, shields.io, quick start, installation, usage, getting started, contributing, license, table of contents, project description, onboarding docs.

A great README answers five questions fast:

  1. What is this? (one sentence, above the fold)
  2. Why should I care? (key features / value)
  3. How do I install and run it? (quick start)
  4. How do I use it? (usage + examples)
  5. How do I contribute / get help / what license?

Workflow

Follow these steps in order. Do not skip the investigation step — accuracy beats fluff.

  1. Detect project type and facts. Run scripts/detect_project.py <repo> (or inspect manually) to identify language, package manager, entry points, scripts, license, and existing badges. This drives which sections apply. See references/section-catalog.md for the type→section mapping.

  2. Confirm the essentials. Gather (ask the user only for what you cannot infer): project name, one-line tagline, target audience, install command, minimal run/usage example, license, and repo URL (for badge slugs).

  3. Choose sections. Start from the canonical order below and drop sections that do not apply. Never include an empty or placeholder section.

  4. Draft the header block. Title (H1) → tagline (one line, no period needed) → badge row → optional hero image/demo → table of contents (only if the README is long, roughly 6+ H2 sections).

  5. Write Quick Start. The single most important section. A reader should be able to copy-paste their way to a running result in under a minute. Use a fenced code block with a language hint and real commands.

Read the full file on GitHub · 150 lines

Files

What ships with it

7 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. 2d ago First seen · 150 lines · 107 tokens per session scan A 252de3ef5c9b

Subscribe to this mod's changes

readme-generator is a skill published in the GitHub repository JayRHa/AgentSkills (4 stars, last pushed 1mo ago), licensed MIT. It adds 107 tokens to every session and 1,618 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.

Related

Other skills, from other repositories

reverse-engineering-tools

Guide for reverse engineering protected games and anti-cheat components across user mode, kernel mode, and hypervisor-aware environments. Use this skill when analyzing drivers, IOCTL protocols, callback registration, injected-code artifacts, integrity checks, protected binaries, or debugging security-sensitive game…

gmh5225/awesome-game-security · 60 tokens

curating-bgs-modpack

Use when planning or building the whole Bethesda modpack incrementally — batch strategy, rollback point, naming convention, separator discipline, attribution, and declaring 风格 before adding mods. Triggers - "build a modpack", "plan the pack", "batch strategy", "rollback point", "naming convention", "declare 风格"…

hashgraph-online/awesome-codex-plugins · 137 tokens

evaluating-bgs-mods

Use when deciding whether a mod belongs in a modpack — judging mod quality, fit, risk, and pack-value BEFORE download/install. Triggers - "should I add this mod", "is this mod good", "评估这个mod", "这个mod值得装吗", "is this mod worth it", "this mod looks too good to be true", "compare these mods", "does this mod fit my pack".…

hashgraph-online/awesome-codex-plugins · 128 tokens

writing-modpack-changelog

Use when cutting a modpack release. Creates /docs/release-changelog.md if absent; appends a new version section with grouped changes. Triggers - 'cut a release', 'release notes', 'changelog', 'v1.2.3 changes', 'what changed since last version'.

hashgraph-online/awesome-codex-plugins · 69 tokens

agent-newbie-guide

Skill "agent-newbie-guide" from hashgraph-online/awesome-codex-plugins, covering codex 新手引导, 🚫 新手术语过滤(绝对禁止), 统一行为规范(内嵌), 📍 阶段位置 and 启动自检.

hashgraph-online/awesome-codex-plugins · 87 tokens

review-work

Quality gate: verify each acceptance criterion of a completed task/work unit, run quality checks, and create follow-up tasks for gaps. Use before merging or to audit delivered work. Invoked as /agiflow:review-work . Uses getworkunit, gettask, updatetask, createtask, createtaskcomment.

hashgraph-online/awesome-codex-plugins · 72 tokens