UNPKG

994 BMarkdownView Raw
1# Ruban
2
3[![NPM version](https://img.shields.io/npm/v/ruban.svg?style=flat)](https://npmjs.org/package/ruban)
4[![NPM downloads](http://img.shields.io/npm/dm/ruban.svg?style=flat)](https://npmjs.org/package/ruban)
5[![Dependencies](https://david-dm.org/sorrycc/ruban/status.svg)](https://david-dm.org/sorrycc/ruban)
6
7Ruban is a personal tool pack for creating repos.
8
9## Usage
10
11```bash
12# Create a new repo
13$ ruban new [repo]
14
15# Compile src to lib
16$ ruban build
17$ ruban build -w
18$ ruban build --watch
19
20# Test with mocha, report and coveralls
21$ ruban test
22$ ruban debug
23$ ruban coveralls
24
25# Lint with eslint and eslint-config-airbnb
26$ ruban lint
27$ ruban lint-staged
28
29# Publish
30$ ruban pub
31$ ruban pub --beta
32```
33
34## Why is it called Ruban
35
36<img src="https://gw.alipayobjects.com/zos/rmsportal/xuuzthpCbUFrDKGTzIwC.png" width="200" height="200" />
37
38Ruban is [a famous man in the history of China](https://baike.baidu.com/item/%E9%B2%81%E7%8F%AD/346165) who is good at making tools.
39
40## LICENSE
41
42MIT