{{!
    Template for ui-contrib/README.md
}}{{{pkg.name}}}
======

[![Build Status][my_travis_badge_url]][my_travis_url]
[![Code Climate][my_codeclimate_badge_url]][my_codeclimate_url]
[![Code Coverage][my_codeclimate_coverage_badge_url]][my_codeclimate_url]
[![npm version][my_npm_budge_url]][my_npm_url]
[![bower version][my_bower_badge_url]][my_repo_url]

{{{pkg.description}}}


Installation
-------

Install module via [npm][npm_url]

```bash
$ npm install {{pkg.name}} --save
```

Generating UI Files.
-------------------

1. Define `$ui` property in your Apemanfile.
2. Set "{{pkg.name}}" to `$invoke` property.

```javascript
{{{read 'docs/example-Apemanfile.js'}}}
```

Then, generate ui assets via [apeman ui][apeman_ui_doc_url].

```bash
# Generate ui from CLI.
$ apeman ui "my-ui-01"
```

Options
-------

| Name | Type | Description |
| ---- | ---- | ----------- |
{{#each signature.options}}| {{$name}} | {{#if $type}}{{pascalcase $type}}{{else}}String{{/if}} | {{$desc}} |
{{/each}}


Using UI Files
--------------

```javascript
{{{read 'docs/example-ui.js'}}}
```

Documents
-------

{{#each docs}}+ [{{@key}}]({{{this}}})
{{/each}}


License
-------

This software is released under the [{{pkg.license}} License][my_license_url].


Links
-------

+ [apeman][apeman_url]
{{#each see}}+ [{{@key}}]({{{this}}})
{{/each}}


[npm_url]: https://www.npmjs.com/
[apeman_url]: https://github.com/apeman-repo/apeman
[apeman_ui_doc_url]: https://github.com/apeman-repo/apeman#ui
[my_repo_url]: https://github.com/apeman-repo/{{pkg.name}}
[my_travis_url]: http://travis-ci.org/apeman-repo/{{pkg.name}}
[my_bower_badge_url]: https://img.shields.io/bower/v/{{pkg.name}}.svg?style=flat
[my_travis_badge_url]: http://img.shields.io/travis/apeman-repo/{{pkg.name}}.svg?style=flat
[my_license_url]: https://github.com/apeman-repo/{{pkg.name}}/blob/master/LICENSE
[my_codeclimate_url]: http://codeclimate.com/github/apeman-repo/{{pkg.name}}
[my_codeclimate_badge_url]: http://img.shields.io/codeclimate/github/apeman-repo/{{pkg.name}}.svg?style=flat
[my_codeclimate_coverage_badge_url]: http://img.shields.io/codeclimate/coverage/github/apeman-repo/{{pkg.name}}.svg?style=flat
[my_npm_url]: http://www.npmjs.org/package/{{pkg.name}}
[my_npm_budge_url]: http://img.shields.io/npm/v/{{pkg.name}}.svg?style=flat
[coz_url]: http://okunishinishi.github.io/node-coz/apiguide