craft-repository-readme

craft-repository-readme is a skill for Codex from rfdiosuao/AgentSkill. It costs 88 tokens per session (1,479 once invoked), scanned A, original, MIT.

A workflow for creating or improving a GitHub repository README, the main documentation page for a code project. It bases instructions, links, badges, and visuals on the actual repository.

In plain words
What is it for?
Use it to audit, build, or publish a README with setup instructions, navigation, verified links, visuals, and project metadata.
Why use it?
It helps turn scattered project details into trustworthy documentation without making unsupported claims.

Skill for Codex

Written for Codex: agents/openai.yaml present. Also seen: mentions AGENTS.md.

Good fit Use it to audit, build, or publish a README with setup instructions, navigation, verified links, visuals, and project metadata.

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

Made for: 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 craft-repository-readme

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/rfdiosuao/agentskill/craft-repository-readme"><img src="https://agentmods.dev/badge/skills/rfdiosuao/agentskill/craft-repository-readme.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 88 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,479 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.00088 $0.01479
Opus 5 $0.00044 $0.00740
Sonnet 5 $0.00018 $0.00296
Haiku 4.5 $0.00009 $0.00148

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

Security

Grade A, and why

craft-repository-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 10d ago.

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/validate_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.

craft-repository-readme/SKILL.md · 141 lines

How it starts

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

Craft Repository README

Turn a repository into a clear, credible landing page. Base every claim, command, badge, and link on the actual project; visual polish must never outrun accuracy.

Choose the operating mode

  • Use audit mode when the user asks for feedback only. Inspect and report; do not edit or publish.
  • Use build mode when the user asks to create or improve the README. Edit the repository and validate the result.
  • Use publish mode only when the user asks to commit, push, open a pull request, or update repository settings. Follow the repository's normal Git workflow.

1. Inspect the real project

Before drafting, inspect:

  • Existing README*, contribution, security, license, changelog, and deployment documents.
  • Package manifests, entry points, example environment files, test commands, screenshots, logos, and public URLs.
  • Git remote, default branch, release tags, CI workflows, and hosting configuration.
  • Repository-level instructions such as AGENTS.md or CONTRIBUTING.md.

Derive the product name, one-sentence value proposition, audience, supported platforms, install commands, run commands, and deployment story from evidence. If a material fact cannot be verified, omit it or label it clearly as planned.

2. Run a public-scope and security check

Treat README work as a release review. Before exposing details:

  • Search tracked files and staged changes for API keys, private keys, tokens, passwords, cookies, internal hostnames, private IPs, and personal paths.
  • Never paste secrets from local configuration, chat history, shell history, or deployment files.
  • Link to .env.example; never reproduce values from .env.
  • Confirm that screenshots, QR codes, names, and contact links are intentionally public.
  • Preserve license, trademark, attribution, and third-party asset notices.

Stop and surface a concrete blocker if publication would expose sensitive material.

3. Design the story before the decoration

Write the README for this sequence:

Read the full file on GitHub · 141 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. 10d ago First seen · 141 lines · 88 tokens per session scan A df0f33eb9a42

Subscribe to this mod's changes

craft-repository-readme is a skill published in the GitHub repository rfdiosuao/AgentSkill (16 stars, last pushed 29d ago), licensed MIT. It adds 88 tokens to every session and 1,479 once invoked, about $0.0004 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.