好的 README 是项目的门面。一份标准结构通常包含下面这些部分。
| 部分 | 作用 |
|---|---|
| 标题 + 一句话简介 | 让人 3 秒知道这是啥 |
| 徽章（badges） | 直观展示构建、版本、许可证状态 |
| 特性 Features | 列出核心价值点 |
| 安装 Install | 复制即用的安装命令 |
| 用法 Usage | 最小可运行示例 |
| 贡献 Contributing | 告诉别人怎么参与 |
| 许可证 License | 法律层面说明使用权限 |
可直接套用的骨架
# 项目名称 > 一句话简介 ## 特性 - 特性一 - 特性二 ## 安装 ```bash npm install your-pkg ``` ## 用法 ```js import pkg from "your-pkg"; ``` ## 贡献 欢迎 PR 与 Issue。 ## 许可证 MIT
用工具生成能自动带上这些 section，省去手搭骨架。需要徽章写法看《README 徽章怎么加》。
立即使用 AI README 生成器 →