create-readme

create-readme is a skill for Claude Code from tommyvo/useful-prompts. It costs 18 tokens per session (323 once invoked), scanned A, a copy of create-readme, Unlicense.

A skill for creating a structured README.md, the main documentation file commonly placed in a software project. It reviews the project and writes an informative guide using Markdown.

In plain words
What is it for?
Writing a project's overview and usage documentation, with sections and formatting suitable for GitHub.
Why use it?
It removes the need to organize project documentation from scratch and helps ensure the README explains the project clearly.

Skill for Claude Code

Written for Claude Code: disable-model-invocation in frontmatter.

Good fit Writing a project's overview and usage documentation, with sections and formatting suitable for GitHub.

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

Made for: Claude Code.

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

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/tommyvo/useful-prompts/create-readme"><img src="https://agentmods.dev/badge/skills/tommyvo/useful-prompts/create-readme.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 18 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 323 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 94% copy Near-identical to another mod 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.00018 $0.00323
Opus 5 $0.00009 $0.00161
Sonnet 5 $0.00004 $0.00065
Haiku 4.5 $0.00002 $0.00032

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

Security

Grade A, and why

create-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.

Origin

This is a copy

94% identical to create-readme — 3 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

Claude Code/Skills/create-readme/SKILL.md · 23 lines

What it actually says

Role

You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.

Task

  1. Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
  2. Take inspiration from these readme files for the structure, tone and content:
  3. Do not overuse emojis, and keep the readme concise and to the point.
  4. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
  5. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
  6. If you find a logo or icon for the project, use it in the readme's header.
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 · 23 lines · 18 tokens per session scan A ebf363867566

Subscribe to this mod's changes

create-readme is a skill published in the GitHub repository tommyvo/useful-prompts (3 stars, last pushed 12d ago), licensed Unlicense. It adds 18 tokens to every session and 323 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. It is 94% identical to create-readme, differing in 3 lines, and is treated as a copy.

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

insight-error-page

Write or audit an insight-kind error page for the Next.js dev overlay. Use when creating a new errors/ .mdx page, auditing an existing one, or checking that a page matches the framework fix cards. Covers page structure, title alignment, FixCard cards with Copy prompt button, code snippets, terminology verification…

vercel/next.js · 83 tokens

next-cache-components-optimizer

Drive a Next.js route to instant navigation by setting up an agentic loop, under Cache Components / PPR, on initial load (hard navigation) and client-side navigation (soft navigation). Encode the goal as a failing @next/playwright instant() e2e and work it to green, one verified route at a time; the shipped test then…

vercel/next.js · 170 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