AGENT SKILL

add-readme

Create a clear README for a new or existing project.

License 许可
MIT
所属仓库
Zwin-ux/kit
最近更新
2026-11-02
Stars
★ 0
Forks
2

01 前言 Front Matter

name
add-readme
version
0.1.1
description
Create a clear README for a new or existing project.
compatibility
[ "claude-code", "grok-build", "codex" ]

03 SKILL.md 正文

Instructions

  1. Scan the repository structure, package manifests, and existing docs.
  2. Identify what the project does in one short sentence.
  3. Write or update README.md with these sections only when they apply:
    • What it is
    • Quick start
    • Usage
    • Configuration
    • Development
    • License
  4. Prefer real commands from the repo over generic placeholders.
  5. Keep language short, active, and concrete.
  6. Do not invent features that the code does not support.

04 同仓库更多 Skills