项目名称

HERE:一句话简短的描述这个项目.

HERE:项目概述

使用入门

[?] 告诉别人这个项目用来干啥的,如何开始使用?

# 安装
$ sudo gem install xxx
# ......

用法参考

[?] 告诉别人如何使用,举些例子?

贡献

[?] 在CONTRIBUTING.md中写上贡献流程方法,或者写上主要贡献者,或者两者都写上, 如:

详情请参见: CONTRIBUTING

[?] 或者你也可以直接在这里简要的书写:

1. Fork this repository or checkout this repository if you are a Developer role user.
2. Create a branch
3. Commit your changes
4. Push your commits to the branch
5. Submit a merge request

查看项目贡献者名单: CONTRIBUTORS

变更记录 📝

查看项目重要变更记录CHANGELOG

鸣谢 👍

[?] 你的项目中使用了别人的框架或者别人的成果,在这里给出参考项目的链接或者鸣谢个人/团队:

• xxx project. 借鉴参考其框架.
• yyy project. 使用此工具或者框架.

To-Do 👨

[?] 项目目前处于早期阶段, 来一个todo list来记录当前还要做的事情是非常透明的:

• 干完了这件事情了
• 还有一件事
• 还有第二件事情

License

[?] 你选择的License类型. 这里提供的默认License是MIT License. 更多的协议类型请参见这里.