readme-generator

readme-generator is a skill for Claude Code, Codex from armanzeroeight/fastagent-plugins. It costs 28 tokens per session (723 once invoked), scanned A, original, MIT.

A skill for creating README files, the project documents that explain setup, usage, features, and other essential information.

In plain words
What is it for?
Analyzing a project's language and framework, choosing a suitable template, and writing documentation for libraries, command-line tools, web apps, or APIs.
Why use it?
It provides a consistent starting structure so important project instructions are not left out.

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/armanzeroeight/fastagent-plugins/readme-generator
Any agent
npx skills add armanzeroeight/fastagent-plugins --skill readme-generator
Clone the repo
git clone --depth 1 https://github.com/armanzeroeight/fastagent-plugins

Made for: Claude Code, Codex.

Per session 28 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 723 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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 $0.00028 $0.00723
Opus 5 $0.00014 $0.00362
Sonnet 5 $0.00006 $0.00145
Haiku 4.5 $0.00003 $0.00072

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

plugins/documentation-toolkit/skills/readme-generator/SKILL.md · 125 lines

How it starts

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

README Generator

Quick Start

Generate a README based on project type:

# Detect project type
ls package.json && echo "Node.js project" || \
ls setup.py pyproject.toml && echo "Python project" || \
ls go.mod && echo "Go project"

Instructions

Step 1: Analyze Project

Gather project information:

  • Project name (from package.json, pyproject.toml, etc.)
  • Description (from manifest or git)
  • Main language and framework
  • Key features (scan source files)
  • Dependencies (from manifest files)

Step 2: Select Template

Choose template based on project type:

Type Template Key Sections
Library library Installation, API, Examples
CLI Tool cli Installation, Commands, Options
Web App webapp Features, Setup, Deployment
API api Endpoints, Authentication, Examples

Step 3: Generate Core Sections

Title and Description:

# Project Name

Brief one-line description of what the project does.

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Version](https://img.shields.io/badge/version-1.0.0-green.svg)](package.json)

Installation:

## Installation

\`\`\`bash
npm install project-name
# or
pip install project-name
\`\`\`

Usage:

## Usage

\`\`\`javascript
const project = require('project-name');

// Basic example
project.doSomething();
\`\`\`

Step 4: Add Project-Specific Content

Include relevant sections:

  • Features: Bullet list of key capabilities
  • API Reference: For libraries
  • Configuration: For configurable tools
  • Examples: Real-world use cases
  • Contributing: How to contribute
  • License: License information

Step 5: Add Badges and Links

Common badges:

![Build Status](https://github.com/user/repo/workflows/CI/badge.svg)
![Coverage](https://codecov.io/gh/user/repo/branch/main/graph/badge.svg)
![npm version](https://badge.fury.io/js/package-name.svg)

Read the full file on GitHub · 125 lines

Files

What ships with it

2 files 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. 3d ago First seen · 125 lines · 28 tokens per session scan A e2270f3140c0

Subscribe to this mod's changes

readme-generator is a skill published in the GitHub repository armanzeroeight/fastagent-plugins (29 stars, last pushed 1mo ago), licensed MIT. It adds 28 tokens to every session and 723 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.

Related

Other skills, from other repositories

guizang-ppt-skill

生成横向翻页网页 PPT(单 HTML 文件),含 WebGL 背景、章节幕封、数据大字报、图片网格等模板。提供两种风格:① "电子杂志 × 电子墨水"(衬线 + 流体背景 + 暖色) ② "瑞士国际主义"(无衬线 + 网格点阵 + IKB/柠檬黄/柠檬绿/安全橙高亮)。当用户需要制作分享 / 演讲 / 发布会风格的网页 PPT,或提到"杂志风 PPT"、"瑞士风 PPT"、"Swiss Style"、"horizontal swipe deck"时使用。.

proma-ai/Proma · 161 tokens

proma-coach

Proma 使用顾问,主动把用户在 Proma/Agent/Skill/Chat 工具/项目里的摩擦、疑惑、重复解释和低效流程,转成更顺手的使用方式或合适的知识维护动作。触发要积极:用户表达不满、困惑、重复提醒、"为什么没用/不会自动/又要我说"、"算了,我自己来"、"你上次不是说..."、"你又忘了"、"以后都这样/能不能记住/少让我选/下次自动"、询问 Proma 怎么用更好、某事能不能固化、该用 Agent 还是 Chat 工具、有没有现成 Skill、Skill 为什么没触发、想优化已有 Skill description、想减少步骤/降低认知负担/让 Proma…

proma-ai/Proma · 386 tokens

skill-creator

Create new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy.

proma-ai/Proma · 64 tokens

automation

Proma 内嵌自动任务与定时任务 Skill,属于 Proma 自带能力而不是用户临时安装的外部 Skill。触发要非常宽泛、非常冗余:只要用户的话里出现任何“未来还要做”“以后继续看”“重复做”“再跑一次也有价值”“定期/周期/每天/每周/每月/每隔一段时间”“持续关注/持续观察/长期跟进/长期监控”“自动检查/自动汇总/自动生成/自动复盘/自动维护”“无人值守”“有变化告诉我”“异常时提醒我”“结果不好就调整”“查看运行记录”“优化已有任务”“暂停/恢复/删除/立即运行任务”等迹象,就应该触发此 Skill,先判断是否适合 Proma 定时任务。也要覆盖一次性与有限次的延时执行信号:“X…

proma-ai/Proma · 390 tokens

docx

Use this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files). Triggers include: any mention of 'Word doc', 'word document', '.docx', or requests to produce professional documents with formatting like tables of contents, headings, page numbers, or letterheads. Also use when…

proma-ai/Proma · 168 tokens

agent-collaboration

Proma 协作子 Agent Skill。当需要并行探索多个方向(多样性探索)、对抗性审查验证已有方案、或多个长耗时独立任务需要真实可见的子会话时触发。用于判断是否以及如何调用 Proma 内置 collaboration 工具创建协作子会话。简单搜索、短调研、单文件修改、一次性代码审查由父会话直接使用普通工具完成。.

proma-ai/Proma · 101 tokens