readme-generator

readme-generator is a skill for Claude Code, Codex from anchildress1/awesome-github-copilot. It costs 208 tokens per session (2,781 once invoked), scanned A, original, MIT.

A workflow for creating or improving a project's README. A README is the documentation page that explains a project to someone encountering it for the first time.

In plain words
What is it for?
Use it to write or audit sections covering the project, features, technology, architecture, structure, setup, configuration, security, contribution, licence, and related information, with Mermaid diagrams where useful.
Why use it?
It gives the documentation a useful structure so readers can understand the project, install it, configure it, and contribute to it.

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/anchildress1/awesome-github-copilot/readme-generator
Any agent
npx skills add anchildress1/awesome-github-copilot --skill readme-generator
Clone the repo
git clone --depth 1 https://github.com/anchildress1/awesome-github-copilot

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/anchildress1/awesome-github-copilot/readme-generator.svg)](https://agentmods.dev/skills/anchildress1/awesome-github-copilot/readme-generator)
Your own site
<a href="https://agentmods.dev/skills/anchildress1/awesome-github-copilot/readme-generator"><img src="https://agentmods.dev/badge/skills/anchildress1/awesome-github-copilot/readme-generator.svg" alt="Measured on agentmods" height="20"></a>
Per session 208 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,781 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.00208 $0.02781
Opus 5 $0.00104 $0.01391
Sonnet 5 $0.00042 $0.00556
Haiku 4.5 $0.00021 $0.00278

Measured 5d ago against content hash 4e41e0b664c4, 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 5d 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/readme-generator/SKILL.md · 146 lines

How it starts

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

README Generator

A README is a project's front door. The goal of this skill is to help produce a README that is structured, scannable, useful to a stranger reading it for the first time, and useful to the author six months later.

This skill follows the 15-section structure from Giorgi Kobaidze's "15 Essential Sections Every README Needs" (dev.to, 2026), adapted with two opinionated choices:

  1. Mermaid for diagrams, not draw.io / Lucidchart screenshots. Mermaid renders natively in GitHub/GitLab Markdown, lives in version control alongside the code, and is easy to update.
  2. Section selection is intent-driven, not checklist-driven. A "hello world" demo doesn't need an Architecture diagram. A new private monorepo probably doesn't need an Acknowledgements section. Use judgment.

When to use which sections

The 15 sections are a menu, not a mandate. Default to including all of them for a non-trivial project intended for collaborators or public consumption. Trim aggressively for solo experiments or private tooling.

Project type Always include Usually skip
Public open-source (apps, libraries) All 15
Internal team service Title, About, Tech Stack, Architecture, Getting Started, Configuration, Security, Author Acknowledgements, What's Next (use the issue tracker)
CLI tool / library Title, About, Features, Tech Stack, Getting Started, Configuration, How to Contribute, License, Author Architecture, Project Structure
Solo experiment / sandbox Title, About, Getting Started Most others
Documentation-only / tutorial repo Title, About, Table of Contents, Project Structure, License, Author Getting Started, Configuration, Security

If the user hasn't told you which type of project this is, ask before generating. A wrong-shape README wastes both their time and yours.

The 15 sections

For deep guidance on each section — what to include, what to leave out, common mistakes — read references/sections.md. The summary below is enough to draft from when the user has given clear input.

Read the full file on GitHub · 146 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. 5d ago First seen · 146 lines · 208 tokens per session scan A 4e41e0b664c4

Subscribe to this mod's changes

readme-generator is a skill published in the GitHub repository anchildress1/awesome-github-copilot (65 stars, last pushed yesterday), licensed MIT. It adds 208 tokens to every session and 2,781 once invoked, about $0.0010 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-30.

Related

Other skills, from other repositories

GitHub Copilot Testing Patterns

Effective patterns for using GitHub Copilot to generate, refactor, and maintain test code including prompt engineering for test generation, Copilot Chat for debugging, inline suggestions for assertions, and workspace context optimization.

PramodDutta/qaskills · 48 tokens

mcp-server-dev

Use when the user asks to build an MCP server, create an MCP integration, wrap an API for AI agents, or expose tools via the Model Context Protocol. Guides through deployment model selection (remote HTTP, MCPB, local stdio), tool-design patterns, and framework choice before scaffolding code.

euxx/claude-skills-for-copilot · 65 tokens

conventions-improver

Audit and improve project conventions files (AGENTS.md, CLAUDE.md, GEMINI.md). Scans for all conventions files, evaluates quality against a scoring rubric, outputs a quality report, then makes targeted improvements with user approval. Use when asked to check, audit, update, or improve AGENTS.md or similar files.

euxx/claude-skills-for-copilot · 72 tokens

security-threat-model

Repository-grounded threat modeling that enumerates trust boundaries, assets, attacker capabilities, abuse paths, and mitigations, and writes a concise Markdown threat model. Trigger only when the user explicitly asks to threat model a codebase or path, enumerate threats/abuse paths, or perform AppSec threat modeling.…

euxx/claude-skills-for-copilot · 82 tokens

code-review

Multi-agent code review for local changes, files, or directories. Detects bugs, security issues, and conventions-file violations (AGENTS.md/CLAUDE.md/GEMINI.md).

euxx/claude-skills-for-copilot · 41 tokens

comment-analyzer

Analyzes code comments for accuracy, completeness, and long-term maintainability. Detects comment rot and misleading documentation. Use after adding or modifying code comments.

euxx/claude-skills-for-copilot · 35 tokens