apeman-demo-scff/README.md

apeman-demo-scff
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]

[bd_repo_url]: https://github.com/apeman-demo-labo/apeman-demo-scff
[bd_travis_url]: http://travis-ci.org/apeman-demo-labo/apeman-demo-scff
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-demo-labo/apeman-demo-scff.svg?style=flat
[bd_license_url]: https://github.com/apeman-demo-labo/apeman-demo-scff/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-demo-labo/apeman-demo-scff
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-demo-labo/apeman-demo-scff.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-demo-labo/apeman-demo-scff.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-demo-labo/apeman-demo-scff
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-demo-labo/apeman-demo-scff.svg
[bd_npm_url]: http://www.npmjs.org/package/apeman-demo-scff
[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-demo-scff.svg?style=flat
[bd_bower_badge_url]: https://img.shields.io/bower/v/apeman-demo-scff.svg?style=flat

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Demo of scaffold project.

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/readme/01.Installation.md.hbs" Start -->

<a name="section-doc-readme-01-installation-md"></a>
Installation
-----

```bash
npm install apeman-demo-scff --save-dev
```


<!-- Section from "doc/readme/01.Installation.md.hbs" End -->

<!-- Section from "doc/readme/02.Usage.md.hbs" Start -->

<a name="section-doc-readme-02-usage-md"></a>
Usage
---------

```javascript
var apemanScff = require('apeman-scff'),
    scff = require('apeman-demo-scff');

apemanScff(scff, 'project/my-awesome-project', {
    silent: false,
    force: false
}, function (err) {
    /*...*/
});

```


<!-- Section from "doc/readme/02.Usage.md.hbs" End -->

<!-- Section from "doc/readme/03.Templates.md.hbs" Start -->

<a name="section-doc-readme-03-templates-md"></a>
Template Files
--------------

+ [ci/build.js](asset/tmpl/ci/build.js.tmpl)
+ [ci/cover.js](asset/tmpl/ci/cover.js.tmpl)
+ [ci/release.js](asset/tmpl/ci/release.js.tmpl)
+ [ci/report.js](asset/tmpl/ci/report.js.tmpl)
+ [ci/share.js](asset/tmpl/ci/share.js.tmpl)
+ [ci/test.js](asset/tmpl/ci/test.js.tmpl)
+ [ci/tmplify.js](asset/tmpl/ci/tmplify.js.tmpl)
+ [ci/update.js](asset/tmpl/ci/update.js.tmpl)
+ [doc/overview.md](asset/tmpl/doc/overview.md.tmpl)
+ [doc/readme/01.Installation.md.hbs](asset/tmpl/doc/readme/01.Installation.md.hbs.tmpl)
+ [doc/readme/02.Usage.md.hbs](asset/tmpl/doc/readme/02.Usage.md.hbs.tmpl)
+ [example/example-usage.js](asset/tmpl/example/example-usage.js.tmpl)
+ [package.json](asset/tmpl/package.json.tmpl)


<!-- Section from "doc/readme/03.Templates.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/apeman-demo-labo/apeman-demo-scff/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [apeman](https://github.com/apeman-labo/apeman)
+ [apeman-scff-labo](https://github.com/apeman-scff-labo)

<!-- Links End -->