怎么写好一份 README：从入门到让人想用你的项目

README 决定了访客是「Star + 试用」还是「关掉走人」。下面按优先级讲。

1. 前 5 行定生死

标题 + 一句话简介必须说清：它解决什么问题、给谁用。避免「一个高性能的框架」这种空话，改成「把 JSON 一键渲染成终端仪表盘」。

2. 特性用动词、讲收益

• 差：支持缓存。
• 好：内置缓存，重复请求延迟降低 80%。

3. 用法要「复制就能跑」

给一段最小示例，别让人先配十分钟环境。能贴输出截图更好。

4. 贡献与许可证别省

开源项目没有 Contributing 和 License，别人不敢用也不敢提 PR。

5. 写完后朗读一遍

把 README 当陌生人的第一眼来读，卡住的地方就是该改的地方。

觉得手写麻烦？把要点填进工具，先出一版骨架再润色。