readme-docs

readme-docs is a skill for Claude Code, Codex from vosslab/vosslab-skills. It costs 56 tokens per session (2,875 once invoked), scanned A, original, MIT.

A tool for creating or refreshing README.md as the welcoming front page of a software project. It explains the project, its audience, how to get a first result, and where to find deeper documentation.

In plain words
What is it for?
Use it when README.md is missing, short, generic, outdated, or difficult to navigate, especially when it needs purpose, examples, proof, and links to authoritative docs.
Why use it?
It helps newcomers understand the project and decide whether it fits before they have to read the rest of the repository.

Skill for Claude CodeCodex

Written for Claude Code and Codex: shipped in a Claude Code plugin, but also agents/openai.yaml present. Also seen: mentions subagents; mentions AGENTS.md.

Part of the vosslab-skills plugin — 42 skills, 14 agents shipped together

Good fit Use it when README.md is missing, short, generic, outdated, or difficult to…

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

Made for: Claude Code, Codex.

Or install vosslab-skills, the plugin that ships this one along with the rest of its 42 skills, 14 agents.

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-docs

README.md
[![agentmods](https://agentmods.dev/badge/skills/vosslab/vosslab-skills/readme-docs.svg)](https://agentmods.dev/skills/vosslab/vosslab-skills/readme-docs)
Your own site
<a href="https://agentmods.dev/skills/vosslab/vosslab-skills/readme-docs"><img src="https://agentmods.dev/badge/skills/vosslab/vosslab-skills/readme-docs.svg" alt="Measured on agentmods" height="20"></a>
Per session 56 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,875 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.00056 $0.02875
Opus 5 $0.00028 $0.01437
Sonnet 5 $0.00011 $0.00575
Haiku 4.5 $0.00006 $0.00287

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

Security

Grade A, and why

readme-docs 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 6d 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/documentation/readme-docs/SKILL.md · 277 lines

How it starts

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

README landing page

Goal

Make README.md a useful front door for a first-time visitor. Explain what the project does, why it matters, and how to try it. Give readers enough context and proof to decide whether the project fits their needs, then route them to deeper documentation.

Optimize for comprehension, successful onboarding, and a memorable project identity. Give newcomers enough context, evidence, and guidance to understand the work before the documentation links.

This skill is the sole owner of README.md. Other docs skills own their files under docs/; this skill summarizes the most important user-facing information and links to those authoritative details.

Resource routing

The workflow below contains the required process. Load a supporting resource when its decision applies:

Adapt the template to repository evidence and resolve every placeholder before delivery.

Landing-page standard

Answer these questions in the order a newcomer is likely to ask them:

  1. What is this project?
  2. Who is it for, and what problem does it solve?
  3. Why would someone choose or use it?
  4. What does it look like or produce?
  5. How can someone get a meaningful first result?
  6. Where can they learn more?

Read the full file on GitHub · 277 lines

Files

What ships with it

6 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. 6d ago First seen · 277 lines · 56 tokens per session scan A 6abaed2fee59

Subscribe to this mod's changes

readme-docs is a skill published in the GitHub repository vosslab/vosslab-skills (2 stars, last pushed 11d ago), licensed MIT. It adds 56 tokens to every session and 2,875 once invoked, about $0.0003 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

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

next-partial-prefetching-adoption

Turn on Partial Prefetching in a Next.js app and work through the insights it surfaces. Use when the user wants to enable or adopt Partial Prefetching, flip the partialPrefetching flag, opt routes in with export const prefetch = 'partial', audit Link prefetch={true} behavior, preserve existing prefetched UI with…

vercel/next.js · 103 tokens

chronicle

Analyze Copilot session history for standup reports, usage tips, session search, and session reindexing. Use when the user asks for a standup, daily summary, usage tips, workflow recommendations, wants to search or find past sessions by keyword/file/PR, wants to reindex their session store, or asks about deleting…

microsoft/vscode · 72 tokens

babysit-pr

Babysit a GitHub pull request after creation by continuously polling review comments, CI checks/workflow runs, and mergeability state until the PR is merged/closed or user help is required. Diagnose failures, retry likely flaky failures up to 3 times, auto-fix/push branch-related issues when appropriate, and keep…

openai/codex · 114 tokens