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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

推薦閱讀更多精彩內(nèi)容

  • rljs by sennchi Timeline of History Part One The Cognitiv...
    sennchi閱讀 7,424評論 0 10
  • PLEASE READ THE FOLLOWING APPLE DEVELOPER PROGRAM LICENSE...
    念念不忘的閱讀 13,528評論 5 6
  • 我10歲以前是在外婆家度過的,那時候的時光很美好!記得那時候過年時,小年夜,我們這邊是農(nóng)歷24拜灶神,那天外...
    金圓迪閱讀 215評論 0 2
  • 我來到這個城市上學已經(jīng)一年了,被一個溫文爾雅的學長迷住,從此一發(fā)不可收拾。名字很好聽,人很帥。183的身高不算很高...
    阿花大人i閱讀 1,019評論 0 1
  • 絕非世上的等閑之物 或許是因為過于自在 凝固自己 尋找前世 無數(shù)個分身 流淌進無數(shù)人的生命 堅定、寒冷和冷漠 才是...
    只是喜歡蘇東坡閱讀 154評論 0 0