readme-generator

readme-generator is a skill for Claude Code, Codex from ArabelaTso/Skills-4-SE. It costs 69 tokens per session (2,441 once invoked), scanned B, original, Apache-2.0.

A repository-analysis guide that creates a README, the main document explaining what a project does and how to use it.

In plain words
What is it for?
It is for documenting new or existing code repositories, including their dependencies, setup process, entry points, and runnable examples.
Why use it?
It removes the effort of piecing together project purpose, requirements, setup commands, and usage instructions from scattered files.

Skill for Claude CodeCodex

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

Good fit It is for documenting new or existing code repositories, including their dependencies, setup process, entry points, and runnable examples.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/arabelatso/skills-4-se/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 ArabelaTso/Skills-4-SE --skill readme-generator
Clone the repo
git clone --depth 1 https://github.com/ArabelaTso/Skills-4-SE

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

README.md
[![agentmods](https://agentmods.dev/badge/skills/arabelatso/skills-4-se/readme-generator/github.svg)](https://agentmods.dev/skills/arabelatso/skills-4-se/readme-generator)
Your own site
<a href="https://agentmods.dev/skills/arabelatso/skills-4-se/readme-generator"><img src="https://agentmods.dev/badge/skills/arabelatso/skills-4-se/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/arabelatso/skills-4-se/readme-generator"><img src="https://agentmods.dev/badge/skills/arabelatso/skills-4-se/readme-generator.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 69 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,441 The whole file, excluding the scripts and references it only reads on demand.
Security scan B 2 findings. A grade says what 26 rules found in the file — not that it is safe. Third-party audits
  • NVIDIA SkillSpector warn 7 Sept 2026
SkillSpector: 5 findings, up to high

These are SkillSpector’s own severities. On a checked sample its high-severity flags on skills were ~96% false positives — a documented command, a public API, a “never do X” rule — so we show them as a caution to read, not a verdict. Why →

  • high Privilege Escalation · line 129
    Code accesses credential files (SSH keys, AWS credentials, etc.). This could indicate credential theft attempts.
    Fix: Remove references to credential paths. Use environment variables or secrets managers. For docs, use placeholder paths (e.g., /path/to/config). Never load .env or token files in production code paths.
  • high Privilege Escalation · line 131
    Code accesses credential files (SSH keys, AWS credentials, etc.). This could indicate credential theft attempts.
    Fix: Remove references to credential paths. Use environment variables or secrets managers. For docs, use placeholder paths (e.g., /path/to/config). Never load .env or token files in production code paths.
  • high Privilege Escalation · line 371
    Code accesses credential files (SSH keys, AWS credentials, etc.). This could indicate credential theft attempts.
    Fix: Remove references to credential paths. Use environment variables or secrets managers. For docs, use placeholder paths (e.g., /path/to/config). Never load .env or token files in production code paths.
  • medium Privilege Escalation · line 84
    Commands invoke sudo or root privileges. Verify this elevated access is necessary and justified.
    Fix: Avoid sudo/root unless strictly required. Prefer least-privilege patterns. If elevation is needed, document the justification and scope.
  • medium Data Exfiltration · line 190
    Data is being sent to an external URL. This could be legitimate telemetry or data exfiltration. Manual review is recommended.
    Fix: Verify the destination URL is trusted and necessary. Remove or replace with documented APIs. Ensure no secrets, tokens, or PII are transmitted.
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.00069 $0.02441
Opus 5 $0.00034 $0.01221
Sonnet 5 $0.00014 $0.00488
Haiku 4.5 $0.00007 $0.00244

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

Security

Grade B, and why

readme-generator scanned grade B with 2 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 7d 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.

Asks for rootmediumPrivilege escalation

A mod that escalates privileges can change anything on the machine, not only the project.

- Install on Ubuntu: `sudo apt-get install [packages]`

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

curl -X POST http://localhost:3000/api/resources \
skills/readme-generator/SKILL.md · 424 lines

How it starts

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

README Generator

Overview

Analyze a code repository and generate a comprehensive, reproducible README.md that enables users to quickly understand, set up, and use the project with clear instructions and executable examples.

Workflow

1. Analyze Repository Structure

Explore the repository to understand its organization and purpose:

Key files to examine:

  • package.json, pyproject.toml, Cargo.toml, go.mod - Project metadata
  • requirements.txt, Pipfile, pom.xml, build.gradle - Dependencies
  • Main entry points (main.py, index.js, app.py, cmd/main.go)
  • Configuration files (.env.example, config.yaml, settings.py)
  • Build/task files (Makefile, package.json scripts, tasks.py)
  • Documentation (docs/, existing README.md, CONTRIBUTING.md)

Information to extract:

  • Project name and version
  • Programming language(s) and frameworks
  • Project type (application, library, CLI tool, research)
  • Main features and capabilities
  • Dependencies and system requirements
  • Entry points and execution methods

2. Generate Project Introduction

Create a clear, compelling introduction section:

Title and badges:

# Project Name

![License](https://img.shields.io/badge/license-MIT-blue.svg)
![Version](https://img.shields.io/badge/version-1.0.0-green.svg)
![Language](https://img.shields.io/badge/python-3.9+-blue.svg)

Description (2-4 sentences):

  • What the project does
  • Why it exists (problem it solves)
  • Key features or capabilities
  • Target audience or use cases

Example:

## About

[Project Name] is a lightweight web framework for building RESTful APIs with minimal boilerplate. It provides automatic request validation, built-in authentication, and OpenAPI documentation generation. Designed for rapid prototyping and production-ready microservices, it reduces API development time by 50% compared to traditional frameworks.

3. Document Prerequisites

List all system requirements and dependencies:

Read the full file on GitHub · 424 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. 7d ago First seen · 424 lines · 69 tokens per session scan B 97af31c7abfb

Subscribe to this mod's changes

readme-generator is a skill published in the GitHub repository ArabelaTso/Skills-4-SE (252 stars, last pushed 20d ago), licensed Apache-2.0. It adds 69 tokens to every session and 2,441 once invoked, about $0.0003 per session on Opus 5. A static security scan graded it B with 2 findings (asks for root, makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.

Related

Other skills, from other repositories

contact-cache

Track all identified/contacted people across strategies. CSV-backed contact database with dedup by LinkedIn URL or email. Prevents duplicate outreach when running strategies on a recurring cadence.

gooseworks-ai/goose-skills · 38 tokens

service-desk

Runs the IT service desk — intake, triage, prioritization, escalation, knowledge, and the metrics that improve service rather than distort it. Use this to set up or fix a service desk, design ticket priority and escalation, reduce repeat contacts, structure a knowledge base, or work out why a desk hitting its targets…

cbrock84/headcount · 73 tokens

beta-program-management

Running closed and open betas that produce real signal. Beta participant selection, structured feedback collection, beta-to-GA decision criteria, and the difference between soft-launch (no structure, no signal), kitchen-sink (everyone in, no actionable feedback), and structured beta (calibrated cohort, intentional…

rampstackco/claude-skills · 155 tokens

estimating-and-contingency

Produces a cost or effort estimate someone can defend — decomposing the work, choosing between analogous, parametric and bottom-up methods, documenting the basis and its assumptions, expressing confidence as a range, and sizing contingency and management reserve separately. Use this to build an estimate, challenge one…

cbrock84/headcount · 87 tokens

requirement-forge-refiner

Facilitate a structured conversation to define requirement standards for a project — epic and feature definitions, scenario structure, AC format, priority notation, status workflow, and naming conventions. Produces a formal requirement-standards.md that the requirement-quality atom reads via config resolution…

techygarg/lattice · 121 tokens

punch-list-manager

Digital punch list management for construction project closeout. Track deficiencies, assign corrections, photo documentation, and completion verification.

datadrivenconstruction/DDC_Skills_for_AI_Agents_in_Construction · 28 tokens