apeman-demo-tmpl/README.md

Demo of tmpl project.

apeman-demo-tmpl
==========

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

<!-- Badge End -->


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

Demo of tmpl project.

<!-- Description End -->


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



<!-- Overview End -->


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

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

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

```bash
$ npm install apeman-demo-tmpl --save-dev
```


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

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

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

1. Define a tmpl within Apemanfile.js
2. Render templates via apeman tmpl command.

**Apemanfile.js**
```javascript
/** This is an example Apemanfile to use apeman-demo-tmpl */

"use strict";

module.exports = {
    $pkg: {/*...*/},
    $tmpls: {
        // Map file path and template.
        'src/my-dest.txt': require('apeman-demo-tmpl')({
            // Pass rendering params
        })
    }
};

```

Then,
```bash
$ apeman tmpl
```


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

<!-- Section from "doc/guides/03.Params.md.hbs" Start -->

<a name="section-doc-guides-03-params-md"></a>
Params
---------

| Key | Description |
| --- | -------- |

<!-- Section from "doc/guides/03.Params.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-tmpl/blob/master/LICENSE).

<!-- LICENSE End -->


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

Links
------

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

<!-- Links End -->