rc-readme

rc-readme is a skill for Claude Code from rodolfochicone/rc-project. It costs 36 tokens per session (1,917 once invoked), scanned A, original, MIT.

A guide for writing or refreshing a project's README, the main document that explains a codebase, using evidence from its files.

In plain words
What is it for?
Use it to create or update a README based on the real code, dependencies, structure, and existing project documentation.
Why use it?
It prevents documentation from claiming features or setup steps that the project does not actually support.

Skill for Claude Code

Written for Claude Code: effort in frontmatter. Also seen: model in frontmatter; mentions CLAUDE.md; mentions AGENTS.md.

Part of the rc plugin — 32 skills, 2 commands, 4 agents, 5 hooks shipped together

Good fit Use it to create or update a README based on the real code, dependencies, structure, and existing project documentation.

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

Made for: Claude Code.

Or install rc, the plugin that ships this one along with the rest of its 32 skills, 2 commands, 4 agents, 5 hooks.

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

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/rodolfochicone/rc-project/rc-readme"><img src="https://agentmods.dev/badge/skills/rodolfochicone/rc-project/rc-readme.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 36 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,917 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.00036 $0.01917
Opus 5 $0.00018 $0.00958
Sonnet 5 $0.00007 $0.00383
Haiku 4.5 $0.00004 $0.00192

Measured 9d ago against content hash 8c6f222e0f3e, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

rc-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 9d 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/misc/rc-readme/SKILL.md · 134 lines

How it starts

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

README

Produce a README.md that reflects what the code actually does — never invented or aspirational content. Every claim must trace back to a file you read. This skill is standalone and stack-agnostic; it detects the project's technology before writing.

Required Inputs

  • None. Operates on the current repository root.
  • Optional: a target path other than README.md, or specific sections to scope the update to.

Workflow

  1. Gather documentation context.

    • Read, when present: the existing README.md, CLAUDE.md, AGENTS.md, CONTRIBUTING.md, any docs/ overview, and architecture notes or ADRs under docs/, .techdocs/, or .rc/tasks/*/adrs/ (in monorepos there may be more than one .rc directory — scan each one, skipping node_modules, .git, vendor, and _archived/).
    • The existing README defines the structure and tone to preserve. Keep valid sections; only rewrite what is stale.
  2. Detect the stack and analyze the codebase. Read real sources — do not guess.

    • Manifest and stack: inspect go.mod, package.json, pyproject.toml, Cargo.toml, pom.xml, *.csproj, Gemfile, etc. Record real dependency versions, the language, frameworks, and the package/registry.
    • Entry points and public API: the binary main, exported packages, library entry, or CLI commands.
    • HTTP / RPC surface: route definitions, handlers, controllers, or service files. Capture method, path, and the request/response contract from the validation layer (schemas, DTOs, structs).
    • Configuration: environment variables and config files — which are required vs optional, and defaults.
    • Scripts and tasks: real commands from package.json scripts, Makefile, Taskfile, justfile, etc.
    • Persistence: migrations or schema files — tables/collections and their shape.
    • CI/CD: workflows under .github/workflows/ or equivalent — triggers and deploy targets.
    • Project structure: map the real directory tree (Glob), describing each significant directory's purpose.
    • For an unfamiliar framework, spawn an Agent to map the relevant files rather than guessing conventions.

Read the full file on GitHub · 134 lines

Files

What ships with it

5 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. 9d ago First seen · 134 lines · 36 tokens per session scan A 8c6f222e0f3e

Subscribe to this mod's changes

rc-readme is a skill published in the GitHub repository rodolfochicone/rc-project (19 stars, last pushed 1mo ago), licensed MIT. It adds 36 tokens to every session and 1,917 once invoked, about $0.0002 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

agent-carnet

Use this skill when the user asks to save, recall, find, or organize notes. Triggers on: 'remember this', 'save this', 'note this', 'what did we discuss about...', 'check the notebook', 'find in carnet'. Also use proactively when discovering findings worth preserving across sessions.

yamadashy/repomix · 67 tokens

deploy-docker-compose

Run the Omnigent server as a Docker compose stack (server + Postgres) on any Docker host — your laptop, a VPS, EC2 by hand, or as the base layer of any container-platform deploy. Invoke when the user wants to build the image, bring up the compose stack, debug the stack on a host they already have, or extend the stack…

omnigent-ai/omnigent · 84 tokens

security-audit

Audit a codebase or directory for security issues (hardcoded secrets, injection, unsafe deserialization, weak crypto, authz gaps) and produce a structured findings report. Use when the user asks for a security review, an audit, or to check code for vulnerabilities. Report only — never fix.

omnigent-ai/omnigent · 64 tokens

taiyi-ui-design

A design-planning guide for describing how an application's user interface should look and behave. It produces a UI-DESIGN.md document covering layouts, components, interactions, accessibility, and error states.

Dong90/oh-my-taiyiforge · 35 tokens

taiyi-evolve

A workflow skill that compares the implemented code with the frozen design after development and testing. It records architecture changes and proposes updates to DESIGN.md, the document describing the intended system structure.

Dong90/oh-my-taiyiforge · 37 tokens

taiyi-diagram-c4

A code-scanning tool that builds C4 architecture documents from a repository. It separates facts observed in the code from conclusions inferred about the design and uses Mermaid diagrams as the source format.

Dong90/oh-my-taiyiforge · 48 tokens