UNPKG

2.25 kBMarkdownView Raw
1ape-watching
2==========
3
4<!-- Badge Start -->
5<a name="badges"></a>
6
7[![Build Status][bd_travis_shield_url]][bd_travis_url]
8[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
9[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
10[![Dependency Status][bd_gemnasium_shield_url]][bd_gemnasium_url]
11[![npm Version][bd_npm_shield_url]][bd_npm_url]
12
13[bd_repo_url]: https://github.com/ape-repo/ape-watching
14[bd_travis_url]: http://travis-ci.org/ape-repo/ape-watching
15[bd_travis_shield_url]: http://img.shields.io/travis/ape-repo/ape-watching.svg?style=flat
16[bd_license_url]: https://github.com/ape-repo/ape-watching/blob/master/LICENSE
17[bd_codeclimate_url]: http://codeclimate.com/github/ape-repo/ape-watching
18[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/ape-repo/ape-watching.svg?style=flat
19[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/ape-repo/ape-watching.svg?style=flat
20[bd_gemnasium_url]: https://gemnasium.com/ape-repo/ape-watching
21[bd_gemnasium_shield_url]: https://gemnasium.com/ape-repo/ape-watching.svg
22[bd_npm_url]: http://www.npmjs.org/package/ape-watching
23[bd_npm_shield_url]: http://img.shields.io/npm/v/ape-watching.svg?style=flat
24
25<!-- Badge End -->
26
27
28<!-- Description Start -->
29<a name="description"></a>
30
31ape framework module for watching files.
32
33<!-- Description End -->
34
35
36
37
38<!-- Sections Start -->
39<a name="sections"></a>
40
41<!-- Section from "docs/readme/02.Usage.md.hbs" Start -->
42
43<a name="section-docs-readme-02-usage-md"></a>
44Usage
45----
46
47### Watch files.
48
49```javascript
50#!/usr/bin/env
51
52var apeWatching = require('ape-watching');
53
54apeWatching.watchFiles([
55 'src/javascripts/**/*.js',
56 'assets/javascripts/**/*.js'
57], function (ev, filename) {
58 /*...*/
59});
60```
61
62
63<!-- Section from "docs/readme/02.Usage.md.hbs" End -->
64
65
66<!-- Sections Start -->
67
68
69<!-- LICENSE Start -->
70<a name="license"></a>
71
72License
73-------
74This software is released under the [MIT License](https://github.com/ape-repo/ape-watching/blob/master/LICENSE).
75
76<!-- LICENSE End -->
77
78
79<!-- Links Start -->
80<a name="links"></a>
81
82Links
83------
84
85+ [ape-repo](https://github.com/ape-repo)
86+ [nodeunit](https://www.npmjs.com/package/nodeunit)
87
88<!-- Links End -->