ape-tmpl

Templates for ape framework.

Installation

$ npm install ape-tmpl --save-dev

Usage

Generating README.md

.README.md.bud

/**
 * 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,

$ node .README.md.bud

Generating LICENSE

.LICENSE.bud

/**
 * 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,

$ node .LICENSE.bud

License

This software is released under the MIT License.

Links

• ape-repo
• coz