ReadmeSample

本篇已经收录到 fetool['杂七杂八']

项目高大上的第一步就是 包装，所以来看看README的书写套路吧:)

每一项都不是必须，还请自行参考

---

示例的项目名称为： ZhuangDeYiShouHaoBi

Goal and Philosophy

“目标以及哲学”，一个标题瞬间就让项目的气质提升了八个档次。

What’s ZhuangDeYiShouHaoBi

来来来，我们来装个逼。

康忙昂，北鼻。

Why ZhuangDeYiShouHaoBi

自问自答，为毛会有这个项目。

假如有人问劳资，为什么能想到这个伟大的Idea ZhuangDeYiShouHaoBi ，劳资会告诉丫：“因为装逼”。

Requirements

描述下必要的前提条件。

比如：基于koa的项目，就需要 node >= 0.11.9

Installation

如何安装呢？当然越简单越好，体验至上。

Usage

北鼻，这个肿么使用呢？

How It Works

工作原理要不要分享下？如果较复杂还是算了吧，写这里显得不专业，来个 GitPage 提升下逼格。

Writing

肿么开始呢？给爷拉出来溜溜。

More

相关推荐来几发。最好是贴一些国内外 较高级的 、切实有用的 的地址，方便大家延伸阅读。

也更显得偶们专业嘛，最起码证明鸟劳资也是查了很多相关资料的。

Credits

介绍项目成员

Contribute

采纳的PR贡献者列表，假如真的能有可以加上这项:)

License

over

---

您可以通过以下方式联系到我：

• 微博 @聂微东
• 个人Blog fefork.com
• 博客园 犀利的东哥
• QQ群 214199415，群名前端Club。PS:入群__务必请提供git或blog地址__，否则进不去哈:)