1 | # ts-repo-boilerplate
|
2 |
|
3 | - [README in English](README.md)
|
4 |
|
5 | 这是一个 npm 仓库模板。
|
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/necfe/ts-repo-boilerplate.svg?style=flat-square
|
13 | [circleci-url]: https://circleci.com/gh/necfe/ts-repo-boilerplate
|
14 | [npm-img]: http://img.shields.io/npm/v/ts-repo-boilerplate.svg?style=flat-square
|
15 | [npm-url]: http://npmjs.org/package/ts-repo-boilerplate
|
16 | [david-img]: http://img.shields.io/david/necfe/ts-repo-boilerplate.svg?style=flat-square
|
17 | [david-url]: https://david-dm.org/necfe/ts-repo-boilerplate
|
18 | [download-img]: https://img.shields.io/npm/dm/ts-repo-boilerplate.svg?style=flat-square
|
19 | [download-url]: https://npmjs.org/package/ts-repo-boilerplate
|
20 |
|
21 | ## 示例
|
22 |
|
23 | 展示一个简单的示例可以快速吸引读者。
|
24 |
|
25 | ## 特性
|
26 |
|
27 | 介绍一下这个项目主要的几个特性吧。
|
28 |
|
29 | ## 安装
|
30 |
|
31 | ``` shell
|
32 | npm install --save-dev ts-repo-boilerplate
|
33 | ```
|
34 |
|
35 | ## 选项
|
36 |
|
37 | #### name
|
38 |
|
39 | 某个功能的名称。
|
40 |
|
41 | - Type: `string`
|
42 | - Default: `'hello'`
|
43 |
|
44 | #### auto
|
45 |
|
46 | 是否自动做某件事。
|
47 |
|
48 | - Type: `boolean`
|
49 | - Default: `'true'`
|
50 |
|
51 | ## 开发
|
52 |
|
53 | ### dev
|
54 |
|
55 | ``` shell
|
56 | npm run dev
|
57 | ```
|
58 |
|
59 | ### build
|
60 |
|
61 | ``` shell
|
62 | npm run build
|
63 | ```
|
64 |
|
65 | ### test
|
66 |
|
67 | ``` shell
|
68 | npm run test
|
69 | ```
|
70 |
|
71 | ## 修改日志
|
72 |
|
73 | See [Releases](https://github.com/necfe/ts-repo-boilerplate/releases)
|
74 |
|
75 | ## 贡献指南
|
76 |
|
77 | See [Contributing Guide](https://github.com/vusion/DOCUMENTATION/issues/8)
|
78 |
|
79 | ## 开源协议
|
80 |
|
81 | [MIT](LICENSE)
|