UNPKG

2.83 kBMarkdownView Raw
1apeman-scff-tmpl
2==========
3
4<!---
5This file is generated by ape-tmpl. Do not update manually.
6--->
7
8<!-- Badge Start -->
9<a name="badges"></a>
10
11[![Build Status][bd_travis_shield_url]][bd_travis_url]
12[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
13[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
14[![npm Version][bd_npm_shield_url]][bd_npm_url]
15
16[bd_repo_url]: https://github.com/apeman-scff-labo/apeman-scff-tmpl
17[bd_travis_url]: http://travis-ci.org/apeman-scff-labo/apeman-scff-tmpl
18[bd_travis_shield_url]: http://img.shields.io/travis/apeman-scff-labo/apeman-scff-tmpl.svg?style=flat
19[bd_license_url]: https://github.com/apeman-scff-labo/apeman-scff-tmpl/blob/master/LICENSE
20[bd_codeclimate_url]: http://codeclimate.com/github/apeman-scff-labo/apeman-scff-tmpl
21[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-scff-labo/apeman-scff-tmpl.svg?style=flat
22[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-scff-labo/apeman-scff-tmpl.svg?style=flat
23[bd_gemnasium_url]: https://gemnasium.com/apeman-scff-labo/apeman-scff-tmpl
24[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-scff-labo/apeman-scff-tmpl.svg
25[bd_npm_url]: http://www.npmjs.org/package/apeman-scff-tmpl
26[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-scff-tmpl.svg?style=flat
27[bd_bower_badge_url]: https://img.shields.io/bower/v/apeman-scff-tmpl.svg?style=flat
28
29<!-- Badge End -->
30
31
32<!-- Description Start -->
33<a name="description"></a>
34
35Scaffold for tmpl projects.
36
37<!-- Description End -->
38
39
40<!-- Overview Start -->
41<a name="overview"></a>
42
43
44
45<!-- Overview End -->
46
47
48<!-- Sections Start -->
49<a name="sections"></a>
50
51<!-- Section from "doc/readme/01.Installation.md.hbs" Start -->
52
53<a name="section-doc-readme-01-installation-md"></a>
54Installation
55-----
56
57```bash
58npm install apeman-scff-tmpl --save-dev
59```
60
61
62<!-- Section from "doc/readme/01.Installation.md.hbs" End -->
63
64<!-- Section from "doc/readme/02.Usage.md.hbs" Start -->
65
66<a name="section-doc-readme-02-usage-md"></a>
67Usage
68---------
69
70```javascript
71"use strict";
72
73const apemanScaffold = require('apeman-scaffold'),
74 scaffold = require('apeman-scaffold-tmpl');
75
76apemanScaffold(scaffold, 'project/my-awesome-project', {
77 silent: false,
78 force: false
79}, (err) => {
80 /*...*/
81});
82
83```
84
85
86<!-- Section from "doc/readme/02.Usage.md.hbs" End -->
87
88
89<!-- Sections Start -->
90
91
92<!-- LICENSE Start -->
93<a name="license"></a>
94
95License
96-------
97This software is released under the [MIT License](https://github.com/apeman-scff-labo/apeman-scff-tmpl/blob/master/LICENSE).
98
99<!-- LICENSE End -->
100
101
102<!-- Links Start -->
103<a name="links"></a>
104
105Links
106------
107
108+ [apeman](https://github.com/apeman-labo/apeman)
109+ [apeman-scff-labo](https://github.com/apeman-scff-labo)
110
111<!-- Links End -->