What is readme-generator?

A tool for creating or improving a README, the main guide file that explains what a project does and how to use it.

Generating a README from a project's files, including its introduction, features, setup steps, usage examples, and optional contribution or license sections.

It saves time writing project documentation and helps make installation, usage, contribution, and project details easier to understand.

How wangqiqi/trae-ai configures Claude Code and Codex

Reuse

Borrowing it

Nothing to install: this file belongs to wangqiqi/trae-ai. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/wangqiqi/trae-ai/master/.trae/skills/readme-generator/SKILL.md

Clone the repo

git clone --depth 1 https://github.com/wangqiqi/trae-ai

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.

README.md

[![agentmods](https://agentmods.dev/badge/skills/wangqiqi/trae-ai/readme-generator/github.svg)](https://agentmods.dev/skills/wangqiqi/trae-ai/readme-generator)

Your own site

<a href="https://agentmods.dev/skills/wangqiqi/trae-ai/readme-generator"><img src="https://agentmods.dev/badge/skills/wangqiqi/trae-ai/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.

Your own site · 80×15

<a href="https://agentmods.dev/skills/wangqiqi/trae-ai/readme-generator"><img src="https://agentmods.dev/badge/skills/wangqiqi/trae-ai/readme-generator.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 24 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.

When invoked 378 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.

Model	Per session	Once invoked
Fable 5.1	$0.00024	$0.00378
Opus 5.5	$0.00010	$0.00151
Sonnet 5.5	$0.00005	$0.00076
Haiku 4.5	$0.00002	$0.00038

Measured 2mo ago against content hash 7294fd4091a9, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 2mo 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.

.trae/skills/readme-generator/SKILL.md · 70 lines

What it actually says

README 生成器

描述

自动为项目生成美观、专业的 README 文档，包含完整的项目介绍、安装说明、使用指南、贡献指南等内容。

使用场景

新建项目时，快速生成基础 README
已有项目需要完善或更新文档
发布开源项目前，准备规范的项目说明

指令

生成 README 时，你应该：

分析项目信息
- 检测项目类型（通过 package.json、requirements.txt 等文件）
- 了解项目的主要功能和特点
- 识别技术栈和依赖
生成标准结构
- 项目标题和简介
- 功能特性列表
- 安装和配置说明
- 使用示例和指南
- 贡献指南（可选）
- 许可证信息（可选）
优化内容
- 使用清晰、易懂的语言
- 提供具体的使用示例
- 根据项目特点调整内容侧重点

示例

输出的 README 结构

# 项目名称

> 项目简短描述

## ✨ 功能特性
- 功能 1
- 功能 2
- 功能 3

## 🚀 快速开始

### 安装
```bash
# 安装依赖
npm install

使用

// 使用示例

📖 文档

🤝 贡献指南

📄 许可证

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.

2mo ago First seen · 70 lines · 24 tokens per session scan A 7294fd4091a9

Subscribe to this mod's changes

readme-generator is a skill published in the GitHub repository wangqiqi/trae-ai (25 stars, last pushed 4mo ago), licensed MIT. It adds 24 tokens to every session and 378 once invoked, about $0.0001 per session on Opus 5.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.

Writing and docs

readme-generator next to 6 skills from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
readme-generatorwangqiqi/trae-ai	Skill	25	4mo ago	MIT	A	24	Claude Code, Codex
imagegenopenai/codex	Skill	133k	yesterday	Apache-2.0	A	113	Codex
playwright-climicrosoft/playwright	Skill	99k	yesterday	Apache-2.0	A	19	Claude Code
local-ai-agentsmicrosoft/ai-agents-for-beginners	Skill	79k	4d ago	MIT	A	200	Claude Code, Codex
systematic-debuggingobra/superpowers	Skill	313k	3d ago	MIT	A	21	Claude Code
next-cache-components-adoptionvercel/next.js	Skill	143k	yesterday	MIT	A	95	Claude Code
next-partial-prefetching-adoptionvercel/next.js	Skill	143k	yesterday	MIT	A	103	Claude Code

trae-ai: Skill for Claude Code