1 | apeman-demo-scff
|
2 | ==========
|
3 |
|
4 |
|
5 | This file is generated by ape-tmpl. Do not update manually.
|
6 | --->
|
7 |
|
8 |
|
9 | <a name="badges"></a>
|
10 |
|
11 | [![Build Status][bd_travis_shield_url]][bd_travis_url]
|
12 | [![npm Version][bd_npm_shield_url]][bd_npm_url]
|
13 | [![JS Standard][bd_standard_shield_url]][bd_standard_url]
|
14 |
|
15 | [bd_repo_url]: https://github.com/apeman-demo-labo/apeman-demo-scff
|
16 | [bd_travis_url]: http://travis-ci.org/apeman-demo-labo/apeman-demo-scff
|
17 | [bd_travis_shield_url]: http://img.shields.io/travis/apeman-demo-labo/apeman-demo-scff.svg?style=flat
|
18 | [bd_travis_com_url]: http://travis-ci.com/apeman-demo-labo/apeman-demo-scff
|
19 | [bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-demo-labo/apeman-demo-scff.svg?token=
|
20 | [bd_license_url]: https://github.com/apeman-demo-labo/apeman-demo-scff/blob/master/LICENSE
|
21 | [bd_codeclimate_url]: http://codeclimate.com/github/apeman-demo-labo/apeman-demo-scff
|
22 | [bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-demo-labo/apeman-demo-scff.svg?style=flat
|
23 | [bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-demo-labo/apeman-demo-scff.svg?style=flat
|
24 | [bd_gemnasium_url]: https://gemnasium.com/apeman-demo-labo/apeman-demo-scff
|
25 | [bd_gemnasium_shield_url]: https://gemnasium.com/apeman-demo-labo/apeman-demo-scff.svg
|
26 | [bd_npm_url]: http://www.npmjs.org/package/apeman-demo-scff
|
27 | [bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-demo-scff.svg?style=flat
|
28 | [bd_standard_url]: http://standardjs.com/
|
29 | [bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
|
30 |
|
31 |
|
32 |
|
33 |
|
34 |
|
35 | <a name="description"></a>
|
36 |
|
37 | Demo of scaffold project.
|
38 |
|
39 |
|
40 |
|
41 |
|
42 |
|
43 | <a name="overview"></a>
|
44 |
|
45 |
|
46 |
|
47 |
|
48 |
|
49 |
|
50 |
|
51 | <a name="sections"></a>
|
52 |
|
53 |
|
54 |
|
55 | <a name="section-doc-guides-01-installation-md"></a>
|
56 |
|
57 | Installation
|
58 | -----
|
59 |
|
60 | ```bash
|
61 | npm install apeman-demo-scff --save-dev
|
62 | ```
|
63 |
|
64 |
|
65 |
|
66 |
|
67 |
|
68 |
|
69 | <a name="section-doc-guides-02-usage-md"></a>
|
70 |
|
71 | Usage
|
72 | ---------
|
73 |
|
74 | ```javascript
|
75 | 'use strict'
|
76 |
|
77 | const apemanScff = require('apeman-scff')
|
78 | const scff = require('apeman-demo-scff')
|
79 |
|
80 | apemanScff(scff, 'project/my-awesome-project', {
|
81 | silent: false,
|
82 | force: false
|
83 | }).then(() => {
|
84 | /* ... */
|
85 | })
|
86 |
|
87 | ```
|
88 |
|
89 |
|
90 |
|
91 |
|
92 |
|
93 |
|
94 | <a name="section-doc-guides-03-templates-md"></a>
|
95 |
|
96 | Template Files
|
97 | --------------
|
98 |
|
99 | + [ci/build.js](asset/tmpl/ci/build.js.tmpl)
|
100 | + [ci/format.js](asset/tmpl/ci/format.js.tmpl)
|
101 | + [ci/release.js](asset/tmpl/ci/release.js.tmpl)
|
102 | + [ci/share.js](asset/tmpl/ci/share.js.tmpl)
|
103 | + [ci/test.js](asset/tmpl/ci/test.js.tmpl)
|
104 | + [ci/update.js](asset/tmpl/ci/update.js.tmpl)
|
105 | + [doc/guides/01.Installation.md.hbs](asset/tmpl/doc/guides/01.Installation.md.hbs.tmpl)
|
106 | + [doc/guides/02.Usage.md.hbs](asset/tmpl/doc/guides/02.Usage.md.hbs.tmpl)
|
107 | + [doc/links.json](asset/tmpl/doc/links.json.tmpl)
|
108 | + [doc/overview.md](asset/tmpl/doc/overview.md.tmpl)
|
109 | + [example/example-usage.js](asset/tmpl/example/example-usage.js.tmpl)
|
110 | + [lib/index.js](asset/tmpl/lib/index.js.tmpl)
|
111 | + [package.json](asset/tmpl/package.json.tmpl)
|
112 | + [README.md](asset/tmpl/README.md.tmpl)
|
113 | + [test/index_test.js](asset/tmpl/test/index_test.js.tmpl)
|
114 |
|
115 |
|
116 |
|
117 |
|
118 |
|
119 |
|
120 |
|
121 |
|
122 |
|
123 | <a name="license"></a>
|
124 |
|
125 | License
|
126 | -------
|
127 | This software is released under the [MIT License](https://github.com/apeman-demo-labo/apeman-demo-scff/blob/master/LICENSE).
|
128 |
|
129 |
|
130 |
|
131 |
|
132 |
|
133 | <a name="links"></a>
|
134 |
|
135 | Links
|
136 | ------
|
137 |
|
138 | + [apeman][apeman_url]
|
139 | + [apeman-scff-labo][apeman_scff_labo_url]
|
140 |
|
141 | [apeman_url]: https://github.com/apeman-labo/apeman
|
142 | [apeman_scff_labo_url]: https://github.com/apeman-scff-labo
|
143 |
|
144 |
|