ape-tmpl

ape-tmpl
==========

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/ape-repo/ape-tmpl
[bd_travis_url]: http://travis-ci.org/ape-repo/ape-tmpl
[bd_travis_shield_url]: http://img.shields.io/travis/ape-repo/ape-tmpl.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/ape-repo/ape-tmpl
[bd_travis_com_shield_url]: https://api.travis-ci.com/ape-repo/ape-tmpl.svg?token=
[bd_license_url]: https://github.com/ape-repo/ape-tmpl/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/ape-repo/ape-tmpl
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/ape-repo/ape-tmpl.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/ape-repo/ape-tmpl.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/ape-repo/ape-tmpl
[bd_gemnasium_shield_url]: https://gemnasium.com/ape-repo/ape-tmpl.svg
[bd_npm_url]: http://www.npmjs.org/package/ape-tmpl
[bd_npm_shield_url]: http://img.shields.io/npm/v/ape-tmpl.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

Templates for ape framework.

Installation
------------

``bash
$ npm install ape-tmpl --save-dev
`

Usage
-----

$3

.README.md.bud

`javascript
/**
* Bud file for README.md
*/

'use strict'

const apeTmpl = require('ape-tmpl')
const pkg = require('./package.json')

module.exports = apeTmpl.readmeMdBud({
pkg: pkg,
repo: 'okunishinishi/my-awesome-one',
sections: 'docs/readme/*.md.hbs', // Each readme section files.
badges: {
travis: true,
codeclimate: true,
codeclimateCoverage: true,
gemnasium: true,
npm: true
}
})

if (!module.parent) {
// This will generate "README.md"
require('coz').render(__filename)
}

`

Then,

`bash
$ node .README.md.bud
`

$3

.LICENSE.bud

`javascript
/**
* Bud file for LICENSE
*/

'use strict'

const apeTmpl = require('ape-tmpl')

module.exports = apeTmpl.licenseBud({
type: 'MIT',
holder: 'apeman-labo',
year: 2015
})

if (!module.parent) {
// This will generate "LICENSE"
require('coz').render(__filename)
}
`

Then,

`bash
$ node .LICENSE.bud
``

License
-------
This software is released under the MIT License.

Links
------

+ [ape-repo][ape_repo_url]
+ [coz][coz_url]

[ape_repo_url]: https://github.com/ape-repo
[coz_url]: https://github.com/coz-labo/coz