用 gitbook 为项目写本书吧
达尔文曾经说过：「任何一个项目都应该有一个 README」。
恩，README.md 对于任何一个项目来说都是不可或缺的一部分，无论是对于使用者还是后续维护者都是灰常重要哒:p
对于小型项目，一个 README.md 足以，但是如果是一个大项目的话（如 midway），那就不是一个 READ
YApi - 高效、易用、功能强大的可视化接口管理平台
YApi
YApi是由去哪儿网移动架构组(简称YMFE，一群由FE、iOS和Android工程师共同组成的最具想象力、创造力和影响力的大前端团队)开源的可视化接口管理工具，一个可本地部署的、打通前后端及QA的接口管理平台，YApi旨在为开发、产品和测试人员提供更优雅的接口管理服务，可以帮助开发者轻松创建、发布和维护不同项目，不同平台的API。