apeman-tmpl-contrib-official/README.md

Template for official apeman modules

apeman-tmpl-contrib-official
======

[![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]

Template for official apeman modules


Installation
-------

Install module via [npm][npm_url]

```bash
npm install apeman-tmpl-contrib-official --save-dev
```

Usage
-------

```javascript
/**
 * @file Evaluate template and render with coz.
 * @see {@link https://github.com/okunishinishi/coz|coz}.
 */

var coz = require('coz'),
    buds = require('apeman-tmpl-contrib-official');

coz.render([
        buds['tmpl-contrib/README.md']({
            //Template data
        })
    ],
    function (err) {
        if (err) {
            console.error(err);
        }
    }
);
```

Buds
-------

Bud for [coz][coz_url].

| Path | Force | Mode | Tmpl |
| --- | --- | --- | --- |
| ci/release.js | false | "755" | [tmpls/hbs/release.js.hbs](tmpls/hbs/release.js.hbs) |
| ci/report.js | false | "755" | [tmpls/hbs/report.js.hbs](tmpls/hbs/report.js.hbs) |
| ci/cover.js | false | "755" | [tmpls/hbs/cover.js.hbs](tmpls/hbs/cover.js.hbs) |
| ci/test.js | false | "755" | [tmpls/hbs/test.js.hbs](tmpls/hbs/test.js.hbs) |
| ci/update.sh | true | "555" | [tmpls/hbs/update.sh.hbs](tmpls/hbs/update.sh.hbs) |
| lib/index.js | true | "444" | [tmpls/hbs/tmpl-contrib/index.js.hbs](tmpls/hbs/tmpl-contrib/index.js.hbs) |
| .gitignore | true | "444" | [tmpls/hbs/gitignore.hbs](tmpls/hbs/gitignore.hbs) |
| LICENSE | true | "444" | [tmpls/hbs/LICENSE.hbs](tmpls/hbs/LICENSE.hbs) |
| README.md | true | "444" | [tmpls/hbs/tmpl-contrib/README.md.hbs](tmpls/hbs/tmpl-contrib/README.md.hbs) |


License
-------
This software is released under the [MIT License][my_license_url].


Links
-------

+ [coz][coz_url]
+ [apeman][apeman_url]


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