UNPKG

2.81 kBMarkdownView Raw
1apeman-demo-scaffold
2==========
3
4<!-- Badge Start -->
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<!-- Badge End -->
26
27
28<!-- Description Start -->
29<a name="description"></a>
30
31Demo of scaffold project.
32
33<!-- Description End -->
34
35
36<!-- Overview Start -->
37<a name="overview"></a>
38
39
40<!-- Overview End -->
41
42
43<!-- Sections Start -->
44<a name="sections"></a>
45
46<!-- Section from "doc/readme/01.Installation.md.hbs" Start -->
47
48<a name="section-doc-readme-01-installation-md"></a>
49Installation
50-----
51
52```bash
53npm install apeman-demo-scaffold --save-dev
54```
55
56<!-- Section from "doc/readme/01.Installation.md.hbs" End -->
57
58<!-- Section from "doc/readme/02.Usage.md.hbs" Start -->
59
60<a name="section-doc-readme-02-usage-md"></a>
61Usage
62---------
63
64```javascript
65var apemanScaffold = require('apeman-scaffold'),
66 scaffold = require('apeman-demo-scaffold');
67
68apemanScaffold(scaffold, 'project/my-awesome-project', {
69 silent: false,
70 force: false
71}, function (err) {
72 /*...*/
73});
74
75```
76
77<!-- Section from "doc/readme/02.Usage.md.hbs" End -->
78
79
80<!-- Sections Start -->
81
82
83<!-- LICENSE Start -->
84<a name="license"></a>
85
86License
87-------
88This software is released under the [MIT License](https://github.com/apeman-demo-labo/apeman-demo-scaffold/blob/master/LICENSE).
89
90<!-- LICENSE End -->
91
92
93<!-- Links Start -->
94<a name="links"></a>
95
96Links
97------
98
99+ [apeman](https://github.com/apeman-labo/apeman)
100+ [apeman-scaffold](https://github.com/apeman-labo/apeman-scaffold)
101
102<!-- Links End -->