npm包README文档

有好的 README 文档的项目不一定是一个好开源项目，但一个好开源项目一定有一个好的 README。

通常README文档的组成部分

（一）国际化

（二）项目工程介绍

（三）项目的使用效果图

（四）项目特点

（五）项目的基本结构（架构）

（六）集成方式

（七）使用方法

（八）混淆

（九）关于作者/组织及交流方式等信息。

（十）贡献者/贡献组织

（十一）鸣谢

（十二）版权信息

结合部门实际情况

1.组件介绍。最好能够一句话简要的介绍组件的功能。

2.环境搭建。如何安装、如何接入、依赖的其他组件等。

3.使用示例。对于简单组件，可以直接在这里写出各种用法；对于复杂组件，可以只写2个左右的示例，其他用法的案例链接到组件的demo目录。

4.效果图。对于UI组件，建议使用效果图，简单的直接使用静态图，复杂的建议使用gif图。

5.CHANGELOG。这个主要是写清楚组件各个版本的特性描述。

6.联系人。