1 | apeman-demo-scaffold
|
2 | ==========
|
3 |
|
4 |
|
5 | <a name="badges"></a>
|
6 |
|
7 | [![Build Status][bd_travis_shield_url]][bd_travis_url]
|
8 | [![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
|
9 | [![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
|
10 | [![npm Version][bd_npm_shield_url]][bd_npm_url]
|
11 |
|
12 | [bd_repo_url]: https://github.com/apeman-demo-labo/apeman-demo-scaffold
|
13 | [bd_travis_url]: http://travis-ci.org/apeman-demo-labo/apeman-demo-scaffold
|
14 | [bd_travis_shield_url]: http://img.shields.io/travis/apeman-demo-labo/apeman-demo-scaffold.svg?style=flat
|
15 | [bd_license_url]: https://github.com/apeman-demo-labo/apeman-demo-scaffold/blob/master/LICENSE
|
16 | [bd_codeclimate_url]: http://codeclimate.com/github/apeman-demo-labo/apeman-demo-scaffold
|
17 | [bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-demo-labo/apeman-demo-scaffold.svg?style=flat
|
18 | [bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-demo-labo/apeman-demo-scaffold.svg?style=flat
|
19 | [bd_gemnasium_url]: https://gemnasium.com/apeman-demo-labo/apeman-demo-scaffold
|
20 | [bd_gemnasium_shield_url]: https://gemnasium.com/apeman-demo-labo/apeman-demo-scaffold.svg
|
21 | [bd_npm_url]: http://www.npmjs.org/package/apeman-demo-scaffold
|
22 | [bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-demo-scaffold.svg?style=flat
|
23 | [bd_bower_badge_url]: https://img.shields.io/bower/v/apeman-demo-scaffold.svg?style=flat
|
24 |
|
25 |
|
26 |
|
27 |
|
28 |
|
29 | <a name="description"></a>
|
30 |
|
31 | Demo of scaffold project.
|
32 |
|
33 |
|
34 |
|
35 |
|
36 |
|
37 | <a name="overview"></a>
|
38 |
|
39 |
|
40 |
|
41 |
|
42 |
|
43 |
|
44 | <a name="sections"></a>
|
45 |
|
46 |
|
47 |
|
48 | <a name="section-doc-readme-01-installation-md"></a>
|
49 | Installation
|
50 | -----
|
51 |
|
52 | ```bash
|
53 | npm install apeman-demo-scaffold --save-dev
|
54 | ```
|
55 |
|
56 |
|
57 |
|
58 |
|
59 |
|
60 | <a name="section-doc-readme-02-usage-md"></a>
|
61 | Usage
|
62 | ---------
|
63 |
|
64 | ```javascript
|
65 | var apemanScaffold = require('apeman-scaffold'),
|
66 | scaffold = require('apeman-demo-scaffold');
|
67 |
|
68 | apemanScaffold(scaffold, 'project/my-awesome-project', {
|
69 | silent: false,
|
70 | force: false
|
71 | }, function (err) {
|
72 | /*...*/
|
73 | });
|
74 |
|
75 | ```
|
76 |
|
77 |
|
78 |
|
79 |
|
80 |
|
81 |
|
82 |
|
83 |
|
84 | <a name="license"></a>
|
85 |
|
86 | License
|
87 | -------
|
88 | This software is released under the [MIT License](https://github.com/apeman-demo-labo/apeman-demo-scaffold/blob/master/LICENSE).
|
89 |
|
90 |
|
91 |
|
92 |
|