# ts-repo-boilerplate

- [README in English](README.md)

这是一个 npm 仓库模板。

[![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/necfe/ts-repo-boilerplate.svg?style=flat-square
[circleci-url]: https://circleci.com/gh/necfe/ts-repo-boilerplate
[npm-img]: http://img.shields.io/npm/v/ts-repo-boilerplate.svg?style=flat-square
[npm-url]: http://npmjs.org/package/ts-repo-boilerplate
[david-img]: http://img.shields.io/david/necfe/ts-repo-boilerplate.svg?style=flat-square
[david-url]: https://david-dm.org/necfe/ts-repo-boilerplate
[download-img]: https://img.shields.io/npm/dm/ts-repo-boilerplate.svg?style=flat-square
[download-url]: https://npmjs.org/package/ts-repo-boilerplate

## 示例

展示一个简单的示例可以快速吸引读者。

## 特性

介绍一下这个项目主要的几个特性吧。

## 安装

``` shell
npm install --save-dev ts-repo-boilerplate
```

## 选项

#### name

某个功能的名称。

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

#### auto

是否自动做某件事。

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

## 开发

### dev

``` shell
npm run dev
```

### build

``` shell
npm run build
```

### test

``` shell
npm run test
```

## 修改日志

See [Releases](https://github.com/necfe/ts-repo-boilerplate/releases)

## 贡献指南

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

## 开源协议

[MIT](LICENSE)