.README.md.bud

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

'use strict'

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

module.exports = apeTmpl.readmeMdBud({
  pkg: pkg,
  repo: pkg.repository,
  sections: 'doc/guides/*.md.hbs',
  badges: {
    travis: true,
    npm: true,
    standard: true
  },
  overview: 'doc/overview.md',
  links: require('./doc/links'),
  vars: {
    bannerHeight: 40,
    funcs: aglob.sync('lib/*.js')
      .filter((filename) => !/index\.js$/.test(filename))
      .map((filename) => {
        let [ comments ] = apeDoc.commentsInFile(filename)
        let [ func ] = comments.function
        return {
          name: func.name,
          description: comments.description,
          params: comments.param,
          returns: comments.returns && comments.returns[ 0 ]
        }
      })
  }
})

if (!module.parent) {
  require('coz').render(__filename)
}