readme书写

1. 小图标

https://shields.io/#/
e.g.

![version](https://img.shields.io/badge/version-v2.0.0-brightgreen.svg?style=flat-square)
[![React](https://img.shields.io/badge/react-^16.3.1-brightgreen.svg?style=flat-square)](https://github.com/facebook/react)
 
[![MIT](https://img.shields.io/dub/l/vibe-d.svg?style=flat-square)](http://opensource.org/licenses/MIT)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request)

2. MIT许可证

MIT License
Copyright (c) 2018 Youeshenzhepei@163.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

3. 语言支持

README.zh-CN.md / README.ZH.md
README.md

4. 语法

    1. 大标题 ====
    2. 中标题 -------
    3. #一级标题
       ##二级标题
       ###三级标题
       ####四级标题
       #####五级标题
       ######六级标题
    4. * 无序列表一
       * 无序列表二
       * 无序列表三
    5. 1. 有序列表一
       2. 有序列表二
       3. 有序列表三
    6. [百度](http://baidu.com)
    7. ![baidu](http://upload-images.jianshu.io/upload_images/6856723-a6b3cafb43ab66f1.gif?imageMogr2/auto-orient/strip "百度logo")
    8. ```Java
       public static void main(String[] args){}
       ```
    9. [x] 已选中
    [] 未选中

5. e.g.

image

Born to build better enterprise frameworks and apps
[![NPM version][npm-image]][npm-url]
[![NPM quality][quality-image]][quality-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![NPM download][download-image]][download-url]
[![Gitter][gitter-image]][gitter-url]
[npm-image]: https://img.shields.io/npm/v/egg.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg
[quality-image]: http://npm.packagequality.com/shield/egg.svg?style=flat-square
[quality-url]: http://packagequality.com/#?package=egg
[travis-image]: https://img.shields.io/travis/eggjs/egg.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg.svg?style=flat-square
[codecov-url]: https://codecov.io/gh/eggjs/egg
[david-image]: https://img.shields.io/david/eggjs/egg.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg
[snyk-image]: https://snyk.io/test/npm/egg/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg
[download-image]: https://img.shields.io/npm/dm/egg.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg
[gitter-image]: https://img.shields.io/gitter/room/eggjs/egg.svg?style=flat-square
[gitter-url]: https://gitter.im/eggjs/egg

Installation

$ npm install egg --save

Node.js >= 8.0.0 required.

Features

  • ✔︎ Built-in process management
  • ✔︎ Plugin system
  • ✔︎ Framework customization
  • ✔︎ Lots of plugins

Docs & Community

Getting Started

Follow the commands listed below.

$ npm install egg-init -g
$ egg-init --type simple showcase && cd showcase
$ npm install
$ npm run dev
$ open http://localhost:7001

Examples

See egg-examples.

How to Contribute

Please let us know how can we help. Do check out issues for bug reports or suggestions first.
To become a contributor, please follow our contributing guide.

License

MIT

  1. e.g.
    Born to build better enterprise frameworks and apps

Installation
npm install egg --save Node.js >= 8.0.0 required. Features ○ ✔︎ Built-in process management ○ ✔︎ Plugin system ○ ✔︎ Framework customization ○ ✔︎ Lots of plugins Docs & Community ○ Website && Documentations ○ Plugins ○ Frameworks ○ Plugin Dependency Getting Started Follow the commands listed below. npm install egg-init -g
egg-init --type simple showcase && cd showcase npm install
npm run dev open http://localhost:7001
Examples
See egg-examples.
How to Contribute
Please let us know how can we help. Do check out issues for bug reports or suggestions first.
To become a contributor, please follow our contributing guide.
License
MIT

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • rljs by sennchi Timeline of History Part One The Cognitiv...
    sennchi阅读 7,448评论 0 10
  • PLEASE READ THE FOLLOWING APPLE DEVELOPER PROGRAM LICENSE...
    念念不忘的阅读 13,549评论 5 6
  • 我10岁以前是在外婆家度过的,那时候的时光很美好!记得那时候过年时,小年夜,我们这边是农历24拜灶神,那天外...
    金圆迪阅读 215评论 0 2
  • 我来到这个城市上学已经一年了,被一个温文尔雅的学长迷住,从此一发不可收拾。名字很好听,人很帅。183的身高不算很高...
    阿花大人i阅读 1,031评论 0 1
  • 绝非世上的等闲之物 或许是因为过于自在 凝固自己 寻找前世 无数个分身 流淌进无数人的生命 坚定、寒冷和冷漠 才是...
    只是喜欢苏东坡阅读 154评论 0 0