readme-generator

readme-generator is a skill for Claude Code, Codex from JayRHa/AgentSkills. It costs 107 tokens per session (1,618 once invoked), scanned A, original, MIT.

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

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

Good fit Writing project introductions, installation and quick-start instructions, usage examples, configuration tables, contribution guidance, badges, and license sections.

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

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

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/jayrha/agentskills/readme-generator"><img src="https://agentmods.dev/badge/skills/jayrha/agentskills/readme-generator.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
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. 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.00107 $0.01618
Opus 5.5 $0.00043 $0.00647
Sonnet 5.5 $0.00021 $0.00324
Haiku 4.5 $0.00011 $0.00162

Measured 1mo ago against content hash 252de3ef5c9b, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 1mo 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. 1mo 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 (12 stars, last pushed 2mo ago), licensed MIT. It adds 107 tokens to every session and 1,618 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-31.

Related

Other skills, from other repositories

cost-optimizer

Trigger when the user asks to audit Claude Code costs, reduce token spend, says "my Claude bill is too high", "optimize my CLAUDE.md", "why is this project burning tokens", or "/cost-optimizer". Scans a project for the common Claude Code cost leaks and returns a prioritized fix list.

mergisi/awesome-openclaw-agents · 69 tokens

excalidraw-architecture

Trigger when the user asks for an architecture diagram, says "draw the system", "update the architecture diagram", "give me an excalidraw of this codebase", or "/excalidraw-architecture". Generates or updates an Excalidraw JSON file at docs/architecture.excalidraw by reading the codebase's key entry points.

mergisi/awesome-openclaw-agents · 78 tokens

model-cost-compare

Trigger when the user asks which model to use, wants to compare model costs, says "what's cheapest for this task", "should I use Opus or Sonnet", "can a smaller model handle this", or "/model-cost-compare". Estimates token cost across Opus 4.6, Sonnet 4.6, GLM-5.1, Minimax M2.7, and local Gemma 4, then recommends the…

mergisi/awesome-openclaw-agents · 104 tokens

openclaw-debugger

Trigger when an OpenClaw agent is broken, silent, crashing, stuck, not responding, returning empty output, or the user says "my agent is down", "agent not working", "/openclaw-debugger". Walks through the standard OpenClaw 2026.4 diagnosis checklist and prints a report.

mergisi/awesome-openclaw-agents · 71 tokens

git-commit-writer

Trigger when the user asks to write a commit message, generate a commit from staged changes, review a diff before committing, or says "/commit". Reads git diff --staged and produces an opinionated, convention-matching commit message.

mergisi/awesome-openclaw-agents · 53 tokens

growth-ideas

Describe your product or project and get three actionable growth ideas tailored to your stage.

mergisi/awesome-openclaw-agents · 20 tokens