readme-cn

readme-cn is a skill for Claude Code, Codex from guyulong/cn-agent-skills. It costs 9 tokens per session (668 once invoked), scanned A, original, MIT.

A template generator for Chinese project README files. A README is the document that explains a project, including its setup, use, structure, and contribution process.

In plain words
What is it for?
Use it to draft Chinese README files with sections for features, installation, examples, documentation, development, testing, and licensing.
Why use it?
It gives Chinese-speaking projects a consistent starting document instead of requiring the README structure to be written from scratch.

Skill for Claude CodeCodex

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

Good fit Use it to draft Chinese README files with sections for features, installation, examples, documentation, development, testing, and licensing.

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

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

README.md
[![agentmods](https://agentmods.dev/badge/skills/guyulong/cn-agent-skills/readme-cn/github.svg)](https://agentmods.dev/skills/guyulong/cn-agent-skills/readme-cn)
Your own site
<a href="https://agentmods.dev/skills/guyulong/cn-agent-skills/readme-cn"><img src="https://agentmods.dev/badge/skills/guyulong/cn-agent-skills/readme-cn/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-cn

Your own site · 80×15
<a href="https://agentmods.dev/skills/guyulong/cn-agent-skills/readme-cn"><img src="https://agentmods.dev/badge/skills/guyulong/cn-agent-skills/readme-cn.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 9 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 668 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.00009 $0.00668
Opus 5 $0.00005 $0.00334
Sonnet 5 $0.00002 $0.00134
Haiku 4.5 $0.00001 $0.00067

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

Security

Grade A, and why

readme-cn 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 10d 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/readme-cn/SKILL.md · 117 lines

What it actually says

中文README模板

使用场景

为项目生成规范的中文README文档。

模板

# 项目名称

简短的项目描述(一句话说明项目是什么、做什么用的)

[![版本](https://img.shields.io/badge/版本-1.0.0-blue.svg)]()
[![许可证](https://img.shields.io/badge/许可证-MIT-green.svg)]()
[![构建状态](https://img.shields.io/badge/构建-通过-brightgreen.svg)]()

## ✨ 特性

- 特性1:简要说明
- 特性2:简要说明
- 特性3:简要说明

## 📦 安装

### 方式一:npm
```bash
npm install your-package

方式二:yarn

yarn add your-package

🚀 快速开始

import { something } from 'your-package';

// 使用示例
const result = something();
console.log(result);

📖 文档

🔧 开发

# 克隆项目
git clone https://github.com/your-username/your-project.git

# 安装依赖
npm install

# 启动开发服务器
npm run dev

# 运行测试
npm test

# 构建
npm run build

📁 项目结构

├── src/
│   ├── index.js      # 入口文件
│   ├── utils.js      # 工具函数
│   └── config.js     # 配置文件
├── tests/            # 测试文件
├── docs/             # 文档
├── package.json
└── README.md

🤝 贡献

欢迎提交 Issue 和 Pull Request!

  1. Fork 本仓库
  2. 创建你的特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交你的改动 (git commit -m '添加某个特性')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 打开一个 Pull Request

📄 许可证

本项目基于 MIT 许可证 - 详见 LICENSE 文件

🙏 致谢


## 注意事项
- 标题使用项目名,不要加版本号
- 特性列表突出亮点
- 安装方式覆盖主流包管理器
- 快速开始代码要能直接运行
- 贡献指南降低参与门槛
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. 10d ago First seen · 117 lines · 9 tokens per session scan A 3be36f8777b7

Subscribe to this mod's changes

readme-cn is a skill published in the GitHub repository guyulong/cn-agent-skills (3 stars, last pushed 3mo ago), licensed MIT. It adds 9 tokens to every session and 668 once invoked, about $0.0000 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.