create-readme

Instructions for creating a structured project README, a document that explains what a software project is and how to use it.

In plain words
What is it for?
Use it when writing or updating README.md, including reviewing the project structure, stack, configuration, existing documentation, and available logo assets.
Why use it?
It gives the assistant a defined process for reviewing the project and producing concise documentation without unrelated sections.

Skill for Claude CodeCodex

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.

agentmods
npx agentmods add skills/jenreh/appkit/create-readme
Any agent
npx skills add jenreh/appkit --skill create-readme
Clone the repo
git clone --depth 1 https://github.com/jenreh/appkit

Made for: Claude Code, Codex.

Per session 53 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 368 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 100% 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 $0.00053 $0.00368
Opus 5 $0.00026 $0.00184
Sonnet 5 $0.00011 $0.00074
Haiku 4.5 $0.00005 $0.00037

Measured 2d ago against content hash 06f5236f071c, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, 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 2d 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

100% identical to create-readme — 0 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/skills/create-readme/SKILL.md · 34 lines

What it actually says

Create README

Role

Senior software engineer. READMEs must be appealing, informative, easy to read.

Workflow

  1. Review entire project and workspace — structure, stack, config, existing docs.
  2. Fetch inspiration from these examples for structure, tone, content:
  3. If project logo/icon exists in assets/ or repo root, use it in the header.
  4. Write the README.

Rules

  • GFM (GitHub Flavored Markdown) throughout.
  • Use GitHub admonitions (> [!NOTE], > [!WARNING], etc.) where appropriate.
  • Keep it concise — no filler sections.
  • Do NOT include: LICENSE, CONTRIBUTING, CHANGELOG sections (dedicated files exist).
  • Do NOT overuse emojis — use sparingly and only where they add clarity.
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. 2d ago First seen · 34 lines · 53 tokens per session scan A 06f5236f071c

Subscribe to this mod's changes

create-readme is a skill published in the GitHub repository jenreh/appkit (4 stars, last pushed 7d ago), licensed MIT. It adds 53 tokens to every session and 368 once invoked, about $0.0003 per session on Opus 5. A static security scan graded it A with 0 findings. It is 100% identical to create-readme, differing in 0 lines, and is treated as a copy.

Related

Other skills, from other repositories

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

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

sandbox-bench

Benchmark React or Next.js changes on Vercel Sandbox VMs with paired A/B statistics: react PR/commit vs base, or Next.js PR/commit vs base, measured end-to-end through the bench/render-pipeline app (rps, latency, p95; TTFB, RSS and document/Flight bytes when the Next side captures them) and, for React changes, through…

vercel/next.js · 212 tokens

v8-jit

V8 JIT optimization patterns for writing high-performance JavaScript in Next.js server internals. Use when writing or reviewing hot-path code in app-render, stream-utils, routing, caching, or any per-request code path. Covers hidden classes / shapes, monomorphic call sites, inline caches, megamorphic deopt, closure…

vercel/next.js · 88 tokens

gh-stack

Manages stacked PRs and splits multi-part work into reviewable branches with gh-stack. Use for stack creation, viewing, edits, push, submit, sync, rebase, merge, or checkout; when asked to split or isolate work for review; whenever a user mentions a stack, branch layers, dependent PRs, or gh stack; or when a stack is…

vercel/next.js · 80 tokens

next-rspack

Maintain @next/rspack-core and @next/rspack-binding packages. Use when editing rspack/package.json, rspack/crates/binding/Cargo.toml, rspack/rust-toolchain.toml, or packages/next-rspack/package.json. Covers upgrading @rspack/core npm version, rspack crate versions, Rust toolchain version, building and linking for…

vercel/next.js · 113 tokens