About create-readme
A skill that reviews a project workspace and creates a structured README.md for it. It guides the writer to use relevant examples, keep the documentation concise, and optionally produce a Chinese reorganization for confirmed personal repositories.
Key features
- 01Reviews the project workspace
- 02Creates a structured README.md
- 03Selects relevant local examples
- 04Applies GFM formatting guidance
- 05Adds README_zh-CN.md for personal repositories
Use cases
- 01Create documentation for a software project
- 02Improve README organization and readability
- 03Document a CLI or sample collection
- 04Prepare Chinese documentation for a personal repository
Install
Copy the command and run it in a terminal.
$
npx skills add https:/After installing, type/create-readmein Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
references/azure-chat-rag-langchainjs.mdazure-serverless-recipes.mdrun-on-output.mdsmoke.mdDetails
From the project READMERole
You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.
Task
- Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
- Take inspiration from these readme examples (local copies in
references/alongside this skill — read the ones closest to the project's type, not all of them) for the structure, tone and content:- Serverless AI Chat with RAG using LangChain.js — full web-app README: badge header, overview, features, setup & deployment steps, resources
- Serverless Recipes for JavaScript/TypeScript — sample collection README: intro, prerequisites, run steps, samples list
- run-on-output — CLI tool README: concise, feature list, install, usage with examples
- smoke — developer tool README: intro, easy example first, install, detailed usage
- Do not overuse emojis, and keep the readme concise and to the point.
- Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
- Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
- If you find a logo or icon for the project, use it in the readme's header.
- Write the README in English by default. Determine whether this is a personal repository (its remote owner matches
gh api user --jq .login; treat it as external if it can't be confirmed). If personal, also write aREADME_zh-CN.md: a Chinese re-organization of the English README — same technical facts, scope, usage steps, and key limitations, not a sentence-by-sentence translation — and cross-link the two files.
Comments
Markdown supported