README.md

README.md文件是一个项目的入门手册，里面介绍了整个项目的使用、功能等等。所以README文件写得好不好，关系到这个项目能不能更容易的被其他人了解和使用。

README至少要写明项目的功能和使用，这是最基本的，当然，一个好的README想要的不仅仅是功能和使用方法。一般npm包和git上面的项目，当然，好的项目都会有README，这已经是一个约定了。

md是Markdown的缩写，其实READEME就是使用Markdown编写的。README既然是为了让别人了解你这个项目，那么应该如何编写？

国际化：

我们都知道GitHub一般都是使用英语，所以可以的话最好写两个版本，一个是英文，为了所有人能看懂，另一个是中文，为了我们更好的理解。

项目名及简介：

简单介绍一下这个项目是做什么的。有的话最好加上demo地址。

功能：

你这个项目可以实现的功能。

用法：

这可以说是最重要的，一定要让别人看得懂你这项目是怎么使用的。

其他：

作者或者是维护人列表、版权、鸣谢、贡献、logo、联系方式等等，这些有的话当然会更加高大上。

Markdown的语法这边推荐简书上的一篇博客：https://www.jianshu.com/p/191d1e21f7ed

推荐在线Markdown编辑器：https://dillinger.io/，把内容清空之后就能在线练习了。

这边为之前发布的npm包写了个README和添加了keywords：

https://www.npmjs.com/package/wade-tools。

这边说一下，之前npm init可以填写的内容，可以直接在package.json直接做修改然后发布。

欢迎关注Coding个人笔记 公众号