readme-generator

readme-generator is a skill for Claude Code from landim32/awesome-ai-skills. It costs 34 tokens per session (2,776 once invoked), scanned A, original, MIT.

A tool that creates or refreshes a standardized README.md, the main documentation file for a software project. It examines the project's technology, configuration, dependencies, structure, scripts, and license before writing the document.

In plain words
What is it for?
Use it to document a new project or regenerate its README from the files and conventions already present.
Why use it?
It removes the work of gathering project details and organizing them into consistent documentation.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter.

Part of the awesome-ai-skills plugin — 36 skills, 11 commands, 8 agents shipped together

Good fit Use it to document a new project or regenerate its README from the files and conventions already present.

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

Made for: Claude Code.

Or install awesome-ai-skills, the plugin that ships this one along with the rest of its 36 skills, 11 commands, 8 agents.

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/landim32/awesome-ai-skills/readme-generator/github.svg)](https://agentmods.dev/skills/landim32/awesome-ai-skills/readme-generator)
Your own site
<a href="https://agentmods.dev/skills/landim32/awesome-ai-skills/readme-generator"><img src="https://agentmods.dev/badge/skills/landim32/awesome-ai-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/landim32/awesome-ai-skills/readme-generator"><img src="https://agentmods.dev/badge/skills/landim32/awesome-ai-skills/readme-generator.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 34 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,776 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.00034 $0.02776
Opus 5 $0.00017 $0.01388
Sonnet 5 $0.00007 $0.00555
Haiku 4.5 $0.00003 $0.00278

Measured 11d ago against content hash 4db1ab833012, 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.

.claude/skills/readme-generator/SKILL.md · 462 lines

How it starts

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

Generate Standardized README.md

You are a README.md generator that creates comprehensive, well-structured project documentation. Your task is to analyze the project and generate a complete README following a strict template.

Input

The user may provide additional context or a project path as argument: $ARGUMENTS

If no arguments are provided, analyze the current project directory.

Instructions

Phase 1 — Project Discovery

Analyze the project to gather all necessary information:

  1. Identify the project type: Check for project files to determine the technology stack:

    • .csproj / .sln → .NET
    • package.json → Node.js / React / Angular
    • pom.xml / build.gradle → Java
    • requirements.txt / pyproject.toml / setup.py → Python
    • go.mod → Go
    • Cargo.toml → Rust
    • Gemfile → Ruby
    • Other config files as needed
  2. Read project configuration files: Read the main project config to extract:

    • Project name and version
    • Description (if available)
    • Dependencies and their versions
    • Build/run scripts
    • License
  3. Analyze the directory structure: Use ls and Glob to understand the folder structure, identify key directories (source, tests, docs, config, docker, CI/CD).

  4. Check for Docker support: Look for Dockerfile, docker-compose.yml, .dockerignore.

  5. Check for CI/CD: Look for .github/workflows/, .gitlab-ci.yml, Jenkinsfile, azure-pipelines.yml, bitbucket-pipelines.yml.

  6. Check for existing badges: Look at existing README (if any), SonarCloud, NuGet, NPM, or other badge sources.

  7. Check for environment configuration: Look for .env.example, appsettings.*.json, config/ directories.

  8. Check for tests: Identify test frameworks and test directory structure.

  9. Check for related ecosystem projects: Look for references to sibling repositories, packages, or monorepo structure.

Phase 2 — Generate README

Generate the README.md following the exact template structure below. Only include sections that are relevant to the project. If the project has no Docker setup, skip the Docker section. If no CI/CD, skip that section.

Read the full file on GitHub · 462 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 · 462 lines · 34 tokens per session scan A 4db1ab833012

Subscribe to this mod's changes

readme-generator is a skill published in the GitHub repository landim32/awesome-ai-skills (1 stars, last pushed 2mo ago), licensed MIT. It adds 34 tokens to every session and 2,776 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-31.

Related

Other skills, from other repositories

cloud-architect

Designs cloud architectures, creates migration plans, generates cost optimization recommendations, and produces disaster recovery strategies across AWS, Azure, and GCP. Use when designing cloud architectures, planning migrations, or optimizing multi-cloud deployments. Invoke for Well-Architected Framework, cost…

Jeffallan/claude-skills · 71 tokens

django-storages-s3

Use when configuring Django to store static and media files on AWS S3 with django-storages. Invoke when working with the STORAGES setting, S3 buckets, presigned URLs, CloudFront, or boto3-backed file storage in settings.py. Configures the Django 4.2+ STORAGES dict, public/private custom backends, presigned GET/POST…

Jeffallan/claude-skills · 138 tokens

kubernetes-specialist

Use when deploying or managing Kubernetes workloads. Invoke to create deployment manifests, configure pod security policies, set up service accounts, define network isolation rules, debug pod crashes, analyze resource limits, inspect container logs, or right-size workloads. Use for Helm charts, RBAC policies…

Jeffallan/claude-skills · 79 tokens

laravel-specialist

Build and configure Laravel 10+ applications, including creating Eloquent models and relationships, implementing Sanctum authentication, configuring Horizon queues, designing RESTful APIs with API resources, and building reactive interfaces with Livewire. Use when creating Laravel models, setting up queue workers…

Jeffallan/claude-skills · 86 tokens

ml-pipeline

Designs and implements production-grade ML pipeline infrastructure: configures experiment tracking with MLflow or Weights & Biases, creates Kubeflow or Airflow DAGs for training orchestration, builds feature store schemas with Feast, deploys model registries, and automates retraining and validation workflows. Use when…

Jeffallan/claude-skills · 123 tokens

nestjs-expert

Creates and configures NestJS modules, controllers, services, DTOs, guards, and interceptors for enterprise-grade TypeScript backend applications. Use when building NestJS REST APIs or GraphQL services, implementing dependency injection, scaffolding modular architecture, adding JWT/Passport authentication, integrating…

Jeffallan/claude-skills · 107 tokens