readme-generator

readme-generator is a skill for Claude Code from davila7/claude-with-skills. It costs 42 tokens per session (643 once invoked), scanned A, original, MIT.

A README generator that examines a project's files, package information, source entry point, structure, and existing documentation to write a README.md.

In plain words
What is it for?
Use it to document a Node.js, Python, Go, Rust, Java, Kotlin, or Ruby project, including its setup, structure, and purpose.
Why use it?
It removes the need to inspect the codebase and assemble basic project documentation by hand.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter.

Good fit Use it to document a Node.js, Python, Go, Rust, Java, Kotlin, or Ruby project, including its setup, structure, and purpose.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/davila7/claude-with-skills/readme-generator
About the project

Claude With Skills is a progressive course that teaches developers to create reusable, portable Agent Skills for Claude Code, from basic SKILL.md files to advanced automation and plugin packaging. It is intended for developers who want repeatable instructions and workflows instead of repeatedly pasting the same guidance. The catalogue contains the course's skills, agents, and instruction.

davila7/claude-with-skills · 12 stars · on GitHub · claude-with-skills.vercel.app

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 davila7/claude-with-skills --skill readme-generator
Clone the repo
git clone --depth 1 https://github.com/davila7/claude-with-skills

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

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/davila7/claude-with-skills/readme-generator"><img src="https://agentmods.dev/badge/skills/davila7/claude-with-skills/readme-generator.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 42 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 643 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.00042 $0.00643
Opus 5 $0.00021 $0.00321
Sonnet 5 $0.00008 $0.00129
Haiku 4.5 $0.00004 $0.00064

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

Security

Grade A, and why

readme-generator 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 11d 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/content/docs/01-basic/lesson-04-documentation-skills/examples/readme-generator/SKILL.md · 76 lines

How it starts

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

Instructions

Step 1: Detect the project type

Check for language and framework indicators in this order:

  • package.json — Node.js / JavaScript / TypeScript project
  • pyproject.toml or setup.py — Python project
  • go.mod — Go project
  • Cargo.toml — Rust project
  • build.gradle or pom.xml — Java / Kotlin project
  • *.gemspec or Gemfile — Ruby project

Read whichever file is found to extract the project name, version, description, and dependencies.

Step 2: Read the entry point

Based on the project type, read the main entry point:

  • Node.js: check the main field in package.json, or look for src/index.ts, src/index.js, index.ts, index.js
  • Python: look for __main__.py, the module directory, or the entry point in pyproject.toml
  • Go: main.go or cmd/<name>/main.go
  • Rust: src/main.rs or src/lib.rs

Read the first 80 lines to understand what the project does.

Step 3: Survey the structure

Run ls -1 at the project root and at the src/ (or equivalent) directory if it exists. Note top-level directories that give structure clues (cli/, api/, lib/, tests/, docs/, examples/).

Step 4: Write the README

Produce a README.md with the following sections in this order. Include a section only if there is real content for it — do not leave placeholder text in any section except Badges.

# Project Name

One sentence describing what the project does and who it is for.

## Badges

<!-- Add badges here: build status, coverage, version, license -->

## Installation

Commands to install the project. Use the package manager detected in step 1.

## Usage

The minimal example to get something working. Show a command or code snippet.
If the project has a CLI, show the most common command.
If it is a library, show an import and a basic function call.

## Configuration

If the project has configuration options (environment variables, config files, flags),
list the important ones with their defaults and descriptions.

## Contributing

Brief instructions: how to set up a dev environment, how to run tests, how to submit a change.

## License

State the license. Read the LICENSE file if present to confirm.

Read the full file on GitHub · 76 lines

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. 11d ago First seen · 76 lines · 42 tokens per session scan A 8c618808c3bd

Subscribe to this mod's changes

readme-generator is a skill published in the GitHub repository davila7/claude-with-skills (12 stars, last pushed 3mo ago), licensed MIT. It adds 42 tokens to every session and 643 once invoked, about $0.0002 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

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