aboutsummaryrefslogtreecommitdiff
path: root/node_modules/ignore-by-default/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/ignore-by-default/README.md')
-rw-r--r--node_modules/ignore-by-default/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/node_modules/ignore-by-default/README.md b/node_modules/ignore-by-default/README.md
new file mode 100644
index 000000000..ee7719119
--- /dev/null
+++ b/node_modules/ignore-by-default/README.md
@@ -0,0 +1,26 @@
+# ignore-by-default
+
+This is a package aimed at Node.js development tools. It provides a list of
+directories that should probably be ignored by such tools, e.g. when watching
+for file changes.
+
+It's used by [AVA](https://www.npmjs.com/package/ava) and
+[nodemon](https://www.npmjs.com/package/nodemon).
+
+[Please contribute!](./CONTRIBUTING.md)
+
+## Installation
+
+```
+npm install --save ignore-by-default
+```
+
+## Usage
+
+The `ignore-by-default` module exports a `directories()` function, which will
+return an array of directory names. These are the ones you should ignore.
+
+```js
+// ['.git', '.sass_cache', …]
+var ignoredDirectories = require('ignore-by-default').directories()
+```