README.md
ape-watching
==========
<!---
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]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![Dependency Status][bd_gemnasium_shield_url]][bd_gemnasium_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-watching
[bd_travis_url]: http://travis-ci.org/ape-repo/ape-watching
[bd_travis_shield_url]: http://img.shields.io/travis/ape-repo/ape-watching.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/ape-repo/ape-watching
[bd_travis_com_shield_url]: https://api.travis-ci.com/ape-repo/ape-watching.svg?token=
[bd_license_url]: https://github.com/ape-repo/ape-watching/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/ape-repo/ape-watching
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/ape-repo/ape-watching.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/ape-repo/ape-watching.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/ape-repo/ape-watching
[bd_gemnasium_shield_url]: https://gemnasium.com/ape-repo/ape-watching.svg
[bd_npm_url]: http://www.npmjs.org/package/ape-watching
[bd_npm_shield_url]: http://img.shields.io/npm/v/ape-watching.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>
ape framework module for watching files.
<!-- Description End -->
<!-- Sections Start -->
<a name="sections"></a>
<!-- Section from "doc/readme/02.Usage.md.hbs" Start -->
<a name="section-doc-readme-02-usage-md"></a>
Usage
----
### Watch files.
```javascript
#!/usr/bin/env
'use strict'
const apeWatching = require('ape-watching')
const watchers = apeWatching.watchFiles([
'src/javascripts/**/*.js',
'assets/javascripts/**/*.js'
], (ev, filename) => {
/* ... */
})
setTimeout(() => {
watchers.forEach((watcher) => {
watcher.close() // Stop watching
})
}, 1000)
```
<!-- Section from "doc/readme/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/ape-repo/ape-watching/blob/master/LICENSE).
<!-- LICENSE End -->
<!-- Links Start -->
<a name="links"></a>
Links
------
+ [ape-repo][ape_repo_url]
[ape_repo_url]: https://github.com/ape-repo
<!-- Links End -->