write-readme
From the author
为 GitHub 项目创建或改写高质量、可执行、证据驱动的双语 README；当用户要求写 README、项目说明或整理项目首页时使用。优先依据项目事实核验功能、命令和链接。
Install
npx skills add huangwb8/skills --skill write-readme -a claude-code
Installs to .claude/skills/write-readme/ · Each command fetches the skill straight from GitHub with the open skills CLI.
Download .zip
Byte-identical to the scanned commit, with the repository’s licence and a SOURCE.txt.
Want your agent to suggest skills while you type? See how to use skills from your IDE.
Safety checks on SKILL.md
- Contains hidden text (invisible characters, long comments or encoded blobs)Medium
- Ships scripts we have not reviewedLow
Why 72
Security75
Provenance60
Maintenance100
Licence100
Adoption31
aiqbench computes the trust score from public signals. It is not a security audit, so read a skill before you install it.
Similar skills
Closest to this one by what they do and when they are used.
- good-readmeevilmartians/agent-skillsWrite or improve a README.md for an open source project. Use this for any request to create, rewrite, review, or polish a README, project description, or "getting started" docs for a library, framework, or tool, or to make an open source project more popular or attractive to users. Do NOT use for internal/private repo docs, API reference generation, or CHANGELOG/CONTRIBUTING files.Writing★ 52
- readme-writermohitagw15856/pm-claude-skillsWrite a clear, well-structured README for a software project or open-source repo. Use when asked to write or improve a README, document a project, or make a repo approachable. Produces a complete README — one-line pitch, badges, quickstart, usage, install, contributing, license — that gets someone from landing to running fast.Writing★ 1.5K
- lov-better-readmelovstudio/skills依据项目代码完善 README、安装说明、使用示例与真实品牌资产。支持明确输入与结果回读。Use to create or improve a project README.Other★ 72
- readme-generatorserejaris/personal-corp-osUse when creating or rewriting README.md for projects. Triggers on "write README", "create README", "update README". Creates human-focused documentation with proper structure.Writing★ 240
- crafting-effective-readmessoftaworks/agent-toolkitUse when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.Writing★ 2.6K
- readmesickn33/agentic-awesome-skillsYou are an expert technical writer creating comprehensive project documentation. Write an accurate README sized to the project and task, with verified setup instructions and links to detailed references.Writing★ 49K
Ratings & reviews
—
no reviews
Tried this skill? Rate it to help others. Sign in
Discussion
Join the discussion. Sign in