coz-bud-remover
Version:
Bud remover for coz.
110 lines (69 loc) • 2.7 kB
Markdown
coz-bud-remover
==========
<!---
This file is generated by ape-tmpl. Do not update manually.
--->
<!-- Badge Start -->
<a name="badges"></a>
[![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/coz-labo/coz-bud-remover
[bd_travis_url]: http://travis-ci.org/coz-labo/coz-bud-remover
[bd_travis_shield_url]: http://img.shields.io/travis/coz-labo/coz-bud-remover.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/coz-labo/coz-bud-remover
[bd_travis_com_shield_url]: https://api.travis-ci.com/coz-labo/coz-bud-remover.svg?token=
[bd_license_url]: https://github.com/coz-labo/coz-bud-remover/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/coz-labo/coz-bud-remover
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/coz-labo/coz-bud-remover.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/coz-labo/coz-bud-remover.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/coz-labo/coz-bud-remover
[bd_gemnasium_shield_url]: https://gemnasium.com/coz-labo/coz-bud-remover.svg
[bd_npm_url]: http://www.npmjs.org/package/coz-bud-remover
[bd_npm_shield_url]: http://img.shields.io/npm/v/coz-bud-remover.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
<!-- Badge End -->
<!-- Description Start -->
<a name="description"></a>
Bud remover for coz.
<!-- Description End -->
<!-- Sections Start -->
<a name="sections"></a>
<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->
<a name="section-doc-guides-01-installation-md"></a>
Installation
-----
```bash
npm install coz-bud-remover --save
```
<!-- Section from "doc/guides/01.Installation.md.hbs" End -->
<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->
<a name="section-doc-guides-02-usage-md"></a>
Usage
----
```javascript
'use strict'
const cozBudRemover = require('coz-bud-remover')
const assert = require('assert')
const remover = cozBudRemover({})
remover.remove('**/.*.bud', (err, buds) => {
assert.ifError(err)
/* ... */
})
```
<!-- Section from "doc/guides/02.Usage.md.hbs" End -->
<!-- Sections Start -->
<!-- LICENSE Start -->
<a name="license"></a>
License
-------
This software is released under the [MIT License](https://github.com/coz-labo/coz-bud-remover/blob/master/LICENSE).
<!-- LICENSE End -->
<!-- Links Start -->
<a name="links"></a>
Links
------
+ [coz][coz_url]
[coz_url]: https://github.com/coz-labo/coz
<!-- Links End -->