From claude-code-starter
Generates professional README.md by analyzing project files like package.json, pyproject.toml, go.mod, directory structure, and CLAUDE.md. Use when writing or supplementing project docs.
How this skill is triggered — by the user, by Claude, or both
Slash command
/claude-code-starter:readme-genThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
帮用户为项目自动生成一份专业的 README 文档。
帮用户为项目自动生成一份专业的 README 文档。
自动读取项目中的关键文件:
有几个信息需要确认:
- 一句话描述这个项目(如果还没有的话)
- 项目目前是什么状态?(开发中 / 可用 / 稳定)
- README 用中文还是英文?
生成包含以下部分的 README.md:
规则:
展示生成的内容,用户确认后写入。
npx claudepluginhub lightpointventures/claude-code-starterGenerates human-focused README files for projects. Activates on 'write README', 'create README', 'update README'.
Generates a README.md template for your project with customizable sections. Useful for starting new projects or improving existing documentation.
Guides creation and improvement of README files for open-source or software projects. Follows community best practices for structure, badges, and quick-start sections.