| 1 | # vusion-api
|
| 2 |
|
| 3 | - [中文说明](README.zh-CN.md)
|
| 4 |
|
| 5 | A boilerplate for creating npm package repo.
|
| 6 |
|
| 7 | [![CircleCI][circleci-img]][circleci-url]
|
| 8 | [![NPM Version][npm-img]][npm-url]
|
| 9 | [![Dependencies][david-img]][david-url]
|
| 10 | [![NPM Download][download-img]][download-url]
|
| 11 |
|
| 12 | [circleci-img]: https://img.shields.io/circleci/project/github/vusion/vusion-api.svg?style=flat-square
|
| 13 | [circleci-url]: https://circleci.com/gh/vusion/vusion-api
|
| 14 | [npm-img]: http://img.shields.io/npm/v/vusion-api.svg?style=flat-square
|
| 15 | [npm-url]: http://npmjs.org/package/vusion-api
|
| 16 | [david-img]: http://img.shields.io/david/vusion/vusion-api.svg?style=flat-square
|
| 17 | [david-url]: https://david-dm.org/vusion/vusion-api
|
| 18 | [download-img]: https://img.shields.io/npm/dm/vusion-api.svg?style=flat-square
|
| 19 | [download-url]: https://npmjs.org/package/vusion-api
|
| 20 |
|
| 21 | ## Example
|
| 22 |
|
| 23 | Show an easy example can attract readers quickly.
|
| 24 |
|
| 25 | ## Features
|
| 26 |
|
| 27 | Introduce some major features of this project.
|
| 28 |
|
| 29 | - Feature 1
|
| 30 | - Feature 2
|
| 31 | - Feature 3
|
| 32 |
|
| 33 | ## Install
|
| 34 |
|
| 35 | ``` shell
|
| 36 | npm install --save vusion-api
|
| 37 | ```
|
| 38 |
|
| 39 | ## Modules
|
| 40 |
|
| 41 | ### fs
|
| 42 |
|
| 43 | 文件系统
|
| 44 |
|
| 45 | ### ms
|
| 46 |
|
| 47 | 物料系统
|
| 48 |
|
| 49 | ### config
|
| 50 |
|
| 51 | vusion.config.js 相关
|
| 52 |
|
| 53 | ### rc
|
| 54 |
|
| 55 | .vusionrc 相关
|
| 56 |
|
| 57 |
|
| 58 | ## Develop
|
| 59 |
|
| 60 | ### dev
|
| 61 |
|
| 62 | ``` shell
|
| 63 | npm run dev
|
| 64 | ```
|
| 65 |
|
| 66 | ### build
|
| 67 |
|
| 68 | ``` shell
|
| 69 | npm run build
|
| 70 | ```
|
| 71 |
|
| 72 | ### test
|
| 73 |
|
| 74 | ``` shell
|
| 75 | npm run test
|
| 76 | ```
|
| 77 |
|
| 78 | ## Changelog
|
| 79 |
|
| 80 | See [Releases](https://github.com/vusion/vusion-api/releases)
|
| 81 |
|
| 82 | ## Contributing
|
| 83 |
|
| 84 | See [Contributing Guide](https://github.com/vusion/DOCUMENTATION/issues/8)
|
| 85 |
|
| 86 | ## License
|
| 87 |
|
| 88 | [MIT](LICENSE)
|