README 文档生成

README 文档生成 is a skill for Claude Code, Codex from cdavid817/vanehub-ai. It costs 21 tokens per session (111 once invoked), scanned A, original, Apache-2.0.

A guide for writing or improving a README, the main project information file commonly shown in a code repository.

In plain words
What is it for?
Use it to document what a project does, setup, common commands, configuration, development workflow, and troubleshooting.
Why use it?
It helps ensure the documentation covers the information developers need before setting up or contributing to a project.

Skill for Claude CodeCodex

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

Good fit Use it to document what a project does, setup, common commands, configuration, development workflow, and troubleshooting.

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

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 文档生成

README.md
[![agentmods](https://agentmods.dev/badge/skills/cdavid817/vanehub-ai/readme-generation/github.svg)](https://agentmods.dev/skills/cdavid817/vanehub-ai/readme-generation)
Your own site
<a href="https://agentmods.dev/skills/cdavid817/vanehub-ai/readme-generation"><img src="https://agentmods.dev/badge/skills/cdavid817/vanehub-ai/readme-generation/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 文档生成

Your own site · 80×15
<a href="https://agentmods.dev/skills/cdavid817/vanehub-ai/readme-generation"><img src="https://agentmods.dev/badge/skills/cdavid817/vanehub-ai/readme-generation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 21 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 111 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. Third-party audits
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
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.00021 $0.00111
Opus 5 $0.00010 $0.00056
Sonnet 5 $0.00004 $0.00022
Haiku 4.5 $0.00002 $0.00011

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

Security

Grade A, and why

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.

src-tauri/resources/skills/system/v1/readme-generation/SKILL.md · 20 lines

What it actually says

README 文档生成

Use this skill to create or improve README content. Cover what the project does, setup, common commands, configuration, development workflow, and troubleshooting.

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 · 20 lines · 21 tokens per session scan A c844b8e47596

Subscribe to this mod's changes

README 文档生成 is a skill published in the GitHub repository cdavid817/vanehub-ai (116 stars, last pushed today), licensed Apache-2.0. It adds 21 tokens to every session and 111 once invoked, about $0.0001 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

openapi-expert

Expert-level OpenAPI/Swagger specification for API design, documentation, and code generation. Use when the user mentions swagger, API specs, REST, API design, or documentation, or when the task involves OpenAPI Specification, Webhooks, or Polymorphism.

personamanagmentlayer/pcl · 57 tokens

absolute-docs

Diátaxis-driven documentation for AI coding agents: write, improve, or audit tutorials, how-tos, reference, explanation, and developer docs (README, CONTRIBUTING, ADRs). Detects the docs stack; gates on the outline before writing prose; verifies every claim against the code before it ships. Triggers on "absolute…

maddhruv/absolute · 102 tokens

harness

Route Harness Starter Kit workflows. Use when the user invokes /harness with adopt, doctor, update, refresh, review, or review sub-agent, or asks to apply, diagnose, maintain, or review repository harness guidance.

harnessworks/harness-starter-kit · 48 tokens

doc-bridge-handoff

Resolve Doc Bridge boundaries before changing code.

AgentsKit-io/doc-bridge · 14 tokens

harness-adopt

Apply Harness Starter Kit prompt-first adoption to a target repository. Use when the user asks to apply, install, adopt, or bootstrap repository harness guidance, checks, memory, and adoption reporting.

harnessworks/harness-starter-kit · 43 tokens

harness-review

Review the current change set from an opposing harness-engineering perspective. Use when the user asks for /harness review, /harness review sub-agent, or a no-edit harness review.

harnessworks/harness-starter-kit · 42 tokens