aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/md/docs/order_watcher/2
diff options
context:
space:
mode:
Diffstat (limited to 'packages/website/md/docs/order_watcher/2')
-rw-r--r--packages/website/md/docs/order_watcher/2/installation.md17
-rw-r--r--packages/website/md/docs/order_watcher/2/introduction.md1
2 files changed, 18 insertions, 0 deletions
diff --git a/packages/website/md/docs/order_watcher/2/installation.md b/packages/website/md/docs/order_watcher/2/installation.md
new file mode 100644
index 000000000..883eb40e5
--- /dev/null
+++ b/packages/website/md/docs/order_watcher/2/installation.md
@@ -0,0 +1,17 @@
+**Install**
+
+```bash
+yarn add @0x/order-watcher
+```
+
+**Import**
+
+```javascript
+import { OrderWatcher } from '@0x/order-watcher';
+```
+
+or
+
+```javascript
+var OrderWatcher = require('@0x/order-utils').OrderWatcher;
+```
diff --git a/packages/website/md/docs/order_watcher/2/introduction.md b/packages/website/md/docs/order_watcher/2/introduction.md
new file mode 100644
index 000000000..b2d574053
--- /dev/null
+++ b/packages/website/md/docs/order_watcher/2/introduction.md
@@ -0,0 +1 @@
+Welcome to the [order-watcher](https://github.com/0xProject/0x-monorepo/tree/development/packages/order-watcher) documentation! OrderWatcher is a daemon that efficiently watches a set of orders, emitting events whenever the validity of an order changes. It can be used by relayers to prune an orderbook, or by traders to keep orders fetched from a Relayer up-to-date.