vusion-api/README.md

Vusion Node.js API

# vusion-api

- [中文说明](README.zh-CN.md)

A boilerplate for creating npm package repo.

[![CircleCI][circleci-img]][circleci-url]
[![NPM Version][npm-img]][npm-url]
[![Dependencies][david-img]][david-url]
[![NPM Download][download-img]][download-url]

[circleci-img]: https://img.shields.io/circleci/project/github/vusion/vusion-api.svg?style=flat-square
[circleci-url]: https://circleci.com/gh/vusion/vusion-api
[npm-img]: http://img.shields.io/npm/v/vusion-api.svg?style=flat-square
[npm-url]: http://npmjs.org/package/vusion-api
[david-img]: http://img.shields.io/david/vusion/vusion-api.svg?style=flat-square
[david-url]: https://david-dm.org/vusion/vusion-api
[download-img]: https://img.shields.io/npm/dm/vusion-api.svg?style=flat-square
[download-url]: https://npmjs.org/package/vusion-api

## Example

Show an easy example can attract readers quickly.

## Features

Introduce some major features of this project.

- Feature 1
- Feature 2
- Feature 3

## Install

``` shell
npm install --save-dev vusion-api
```

## Options

#### name

Name of something.

- Type: `string`
- Default: `'hello'`

#### auto

Do something automatically.

- Type: `boolean`
- Default: `'true'`

## Develop

### dev

``` shell
npm run dev
```

### build

``` shell
npm run build
```

### test

``` shell
npm run test
```

## Changelog

See [Releases](https://github.com/vusion/vusion-api/releases)

## Contributing

See [Contributing Guide](https://github.com/vusion/DOCUMENTATION/issues/8)

## License

[MIT](LICENSE)