How to use
- Copy the installation command and review the source package before installing it in your own agent environment.
- Check the source document for required tools, credentials and supported hosts.
- Describe your input and desired deliverable; review the output against the source material.
npx skills add https://github.com/hu3rror/my-skills --skill create-readmeBefore you start
- Installation does not include a model subscription, API allowance or permission to access your files.
- Repository stars and installation counts describe activity, not an independent quality or security test.
Rendered from the source repository. Headings, examples, code, tables, links, and referenced images are preserved.
Role
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.