readme-generator

readme-generator is a skill for Claude Code from glincker/claude-code-marketplace. It costs 18 tokens per session (1,398 once invoked), scanned A, original, Apache-2.0.

A README generator that examines a software project's files, dependencies, tests, and build setup to produce a README.md guide.

In plain words
What is it for?
Use it to document applications, libraries, or command-line tools, including their languages, frameworks, commands, license, tests, and continuous-integration setup.
Why use it?
It reduces the manual work of documenting what a project contains and how people should install, run, test, and understand it.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter.

Good fit Use it to document applications, libraries, or command-line tools, including their languages, frameworks, commands, license, tests, and continuous-integration setup.

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

Made for: Claude Code.

Its marketplace also offers this one on its own, as the plugin readme-generator/plugin install readme-generator after adding the marketplace above.

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/glincker/claude-code-marketplace/readme-generator.svg)](https://agentmods.dev/skills/glincker/claude-code-marketplace/readme-generator)
Your own site
<a href="https://agentmods.dev/skills/glincker/claude-code-marketplace/readme-generator"><img src="https://agentmods.dev/badge/skills/glincker/claude-code-marketplace/readme-generator.svg" alt="Measured on agentmods" 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 1,398 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.00018 $0.01398
Opus 5 $0.00009 $0.00699
Sonnet 5 $0.00004 $0.00280
Haiku 4.5 $0.00002 $0.00140

Measured 8d ago against content hash cf5b80dd39e4, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-08, 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 8d 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-generator/SKILL.md · 192 lines

How it starts

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

README Generator

Automatically generates professional, comprehensive README.md files by analyzing your project structure, dependencies, and code patterns.

What This Skill Does

This skill helps you create high-quality README files by:

  • Analyzing project structure and identifying key components
  • Detecting programming languages and frameworks
  • Finding configuration files (package.json, requirements.txt, etc.)
  • Identifying test frameworks and CI/CD setup
  • Generating appropriate sections with relevant content
  • Following README best practices

Instructions

When generating a README, follow these steps:

1. Project Discovery

First, analyze the project structure:

  • Use Glob to find key files: package.json, pyproject.toml, Cargo.toml, go.mod, etc.
  • Use Glob to identify main source directories
  • Use Read to examine configuration files
  • Use Grep to find test files and CI configuration

2. Content Analysis

Based on findings, determine:

  • Project type (library, application, CLI tool, etc.)
  • Primary programming language(s)
  • Dependencies and frameworks
  • Build and test commands
  • License type (from LICENSE file)

3. README Generation

Create a README.md with these sections (adapt based on project type):

Required Sections:

  • Title and Description: Project name and one-line summary
  • Features: Key functionality (if applicable)
  • Installation: How to install/set up
  • Usage: Basic usage examples
  • License: License information

Optional Sections (include if relevant):

  • Prerequisites: Required software/tools
  • Development: How to set up for development
  • Testing: How to run tests
  • Contributing: Contribution guidelines
  • API Documentation: For libraries
  • Screenshots: For applications with UI
  • Roadmap: Future plans
  • Acknowledgments: Credits and thanks

4. Writing Style

Use this style for generated READMEs:

  • Clear, concise language
  • Active voice
  • Code blocks with proper syntax highlighting
  • Badge shields for status indicators (if CI/CD detected)
  • Emoji sparingly (only if user requests)
  • Professional but approachable tone

Read the full file on GitHub · 192 lines

Files

What ships with it

1 file 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. 8d ago First seen · 192 lines · 18 tokens per session scan A cf5b80dd39e4

Subscribe to this mod's changes

readme-generator is a skill published in the GitHub repository glincker/claude-code-marketplace (36 stars, last pushed 9mo ago), licensed Apache-2.0. It adds 18 tokens to every session and 1,398 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.