aboutsummaryrefslogtreecommitdiff
path: root/node_modules/fb-watchman/README.md
diff options
context:
space:
mode:
authorJoel Kronqvist <work.joelkronqvist@pm.me>2022-03-11 20:46:06 +0200
committerJoel Kronqvist <work.joelkronqvist@pm.me>2022-03-11 20:46:06 +0200
commit080c5819d87b933816d724a83f3bf4f1686770a7 (patch)
tree4a2ccc68b27edf7d4cbc586c932cc7542b655e19 /node_modules/fb-watchman/README.md
parent5ac7049a9d30733165cc212dee308163c2a14644 (diff)
parentd003b82235a9329f912522a2f70aa950dfce4998 (diff)
downloadLYLLRuoka-080c5819d87b933816d724a83f3bf4f1686770a7.tar.gz
LYLLRuoka-080c5819d87b933816d724a83f3bf4f1686770a7.zip
Merge branch 'master' of https://github.com/JoelHMikael/FoodJS
Updating remote changes
Diffstat (limited to 'node_modules/fb-watchman/README.md')
-rw-r--r--node_modules/fb-watchman/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/node_modules/fb-watchman/README.md b/node_modules/fb-watchman/README.md
new file mode 100644
index 0000000..33da0ad
--- /dev/null
+++ b/node_modules/fb-watchman/README.md
@@ -0,0 +1,34 @@
+# fb-watchman
+
+`fb-watchman` is a filesystem watcher that uses the
+[Watchman](https://facebook.github.io/watchman/) file watching service from
+Facebook.
+
+Watchman provides file change notification services using very
+efficient recursive watches and also allows more advanced change matching and
+filesystem tree querying operations using
+[a powerful expression syntax](https://facebook.github.io/watchman/docs/file-query.html#expressions).
+
+## Install
+
+You should [install Watchman](
+https://facebook.github.io/watchman/docs/install.html) to make the most of this
+module.
+
+Then simply:
+
+```
+$ npm install fb-watchman
+```
+
+## Key Concepts
+
+- Watchman recursively watches directories.
+- Each watched directory is called a `root`.
+- You must initiate a `watch` on a `root` using the `watch-project` command prior to subscribing to changes
+- Rather than separately watching many sibling directories, `watch-project` consolidates and re-uses existing watches relative to a project root (the location of your `.watchmanconfig` or source control repository root)
+- change notifications are relative to the project root
+
+## How do I use it?
+
+[Read the NodeJS watchman documentation](https://facebook.github.io/watchman/docs/nodejs.html)