Readme Skill

Draft, improve, restructure, translate, or audit fact-based GitHub README files. Use when the user wants a README for an open-source repository, bilingual README documentation, badges, README visuals, ASCII architecture diagrams, usage examples, Star History charts, or a safe README rewrite.

38 starsWriting & Content

Install

skills CLI (Claude Code, Cursor, Codex and more)

npx skills add ZardLi1115/readme-skill --skill readme-skill

Manual install

git clone --depth 1 https://github.com/ZardLi1115/readme-skill.git /tmp/readme-skill
mkdir -p ~/.claude/skills
cp -r /tmp/readme-skill/. ~/.claude/skills/readme-skill

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# README Skill

Create accurate, readable GitHub README files by grounding every external claim in repository evidence or explicit user confirmation. Establish value first, provide a fast path to use, then route readers to deeper documentation.

## Non-negotiable rules

- **Drafts are shown in the conversation by default; do not create a draft file automatically.**
- **Do not create or modify `README.md`, `README.zh-CN.md`, or any other README until the user explicitly asks to write or update it.**
- If the user wants a saved draft, use the exact target path they provide; otherwise ask for one. Do not invent a draft filename.
- Never invent commands, APIs, links, badges, performance claims, compatibility promises, release data, community locations, license terms, architecture components, data flows, or repository ownership.
- Never expose API keys in README content, commands committed to a repository, source files, or image URLs. Examples may reference environment variables only.
- Every README draft must include a **Quick Start** section that shows the shortest verified path from availability or installation to a useful result. If that path cannot be verified from repository evidence or user confirmation, ask for the missing first-use details; do not invent, leave empty, or omit the section.

Read the full skill on GitHub

Details

Skill name: readme-skill
Repository: ZardLi1115/readme-skill
License: MIT
Repo updated: 18 August 2026

FAQ

What does the Readme Skill skill do?

How do I install the Readme Skill skill?

skills CLI (Claude Code, Cursor, Codex and more): npx skills add ZardLi1115/readme-skill --skill readme-skill. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Readme Skill popular?

It lives in ZardLi1115/readme-skill, which has 38 GitHub stars and 0 forks.

Related skills

Velvet Ascent

ruijayfeng/velvet-ascent-skill

Use this skill when the user wants a Chinese adult-oriented turn-based text GalGame GM with harem formation, freeform narrative roleplay, natural-escalation yellow-fiction text adventure, multi-character relationship drama, story memory, or novel export. Trigger on requests for 后宫养成, 后宫, 养成, 多女主, 多男后宫, 黄色爽文, 自然流YY文字游戏, 成人向文字冒险, 回合制文字冒险, GalGame, 后宫互动, 逐步升温剧情, 暧昧开局, 自定义身份卡, 文档记忆, 小说导出, 女性向剧情, or any Chinese freeform narrative game where the user wants adult consenting characters, gradual escalation, strong character routes, and long-running continuity.

Writing & Content

Openclaw Docs

tbdavid2019/openclaw-docs-skill

Find authoritative guidance for installing, configuring, operating, securing, and troubleshooting OpenClaw, including channels, model providers, Gateway operations, tools, plugins, automation, nodes, multi-agent routing, and CLI errors. Use for any question or maintenance task involving an OpenClaw installation, `openclaw` CLI command, Gateway daemon, configuration key, or integration.

Writing & Content

A2ui Ask

YuniqueUnic/a2ui-ask

When the user must choose among options or fill in structured config, spawn a browser form (powered by schemaui Web UI, bound to 0.0.0.0), open the user's browser, and write the result to .schemaui/answers/. Never use a terminal/TUI prompt — the agent process has no TTY attachment. Supports rich content: figures on questions and answer options (Mermaid/SVG/Markdown via x-content / x-options) and a live Mermaid editor (x-control: mermaid). Trigger phrases: "give me a form", "ask me via form", "configure", "pick a deploy environment", "I need to choose", "grill me", "a2ui", "给我个表单", "配置一下", "用表单

Writing & ContentIn 1 list

Spec Writer

dannwaneri/spec-writer

Takes a vague feature request and generates a structured spec, technical plan, and task breakdown ready for any coding agent. Use whenever you're about to build a feature and want to reduce ambiguity before writing code. Invoke with /spec-writer followed by your feature description.

Writing & ContentIn 1 list

Cold Message Writer

felixleezd/cold-message-writer

Write cold outreach messages that actually get replies, on LinkedIn, in email, or in X (Twitter) DMs. Use this skill whenever the user wants to reach out cold to someone they don't know or barely know, including phrases like "write a cold DM," "cold email," "LinkedIn message to," "reach out to," "pitch [person]," "how do I get [person] to reply," "DM this investor/recruit/partner/podcast host," "email a founder/company I want to work for," "cold email for a job," "land a job at [company]," "reach out about a role," "follow up with someone who ghosted," or any request to draft a first-touch mes

Writing & Content

Qiaomu Xinzhiyuan Title

joeseesun/qiaomu-xinzhiyuan-title

Rewrite Chinese AI or tech 文章、新闻素材、article titles, article drafts, and source material into 新智元-style headline options for Qiaomu workflows. Use this skill when the user asks for 新智元版标题, 新智元风格起标题, 微信公众号爆款标题改写, or to convert an article/title into a high-density AI media headline while preserving facts.

Writing & Content10

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.