aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/md/docs/order_watcher
diff options
context:
space:
mode:
authorKadinsky <kandinsky454@protonmail.ch>2018-10-19 04:15:31 +0800
committerGitHub <noreply@github.com>2018-10-19 04:15:31 +0800
commit65d85ca5008fe0c307506b388d6ace858122f8ad (patch)
treef8d4b0aa654eab3f26bdbfe40dea6fb7e105e864 /packages/website/md/docs/order_watcher
parent857eb95ac0f8299fe517321cb805a836232222bc (diff)
parentc2038eae5bc02fc24edcb369381b0d9699aed0aa (diff)
downloaddexon-sol-tools-65d85ca5008fe0c307506b388d6ace858122f8ad.tar
dexon-sol-tools-65d85ca5008fe0c307506b388d6ace858122f8ad.tar.gz
dexon-sol-tools-65d85ca5008fe0c307506b388d6ace858122f8ad.tar.bz2
dexon-sol-tools-65d85ca5008fe0c307506b388d6ace858122f8ad.tar.lz
dexon-sol-tools-65d85ca5008fe0c307506b388d6ace858122f8ad.tar.xz
dexon-sol-tools-65d85ca5008fe0c307506b388d6ace858122f8ad.tar.zst
dexon-sol-tools-65d85ca5008fe0c307506b388d6ace858122f8ad.zip
Merge pull request #1158 from 0xProject/docSectionFixes
Update Doc Ref Markdown Sections
Diffstat (limited to 'packages/website/md/docs/order_watcher')
-rw-r--r--packages/website/md/docs/order_watcher/1/installation.md (renamed from packages/website/md/docs/order_watcher/installation.md)0
-rw-r--r--packages/website/md/docs/order_watcher/1/introduction.md (renamed from packages/website/md/docs/order_watcher/introduction.md)0
-rw-r--r--packages/website/md/docs/order_watcher/2/installation.md17
-rw-r--r--packages/website/md/docs/order_watcher/2/introduction.md1
4 files changed, 18 insertions, 0 deletions
diff --git a/packages/website/md/docs/order_watcher/installation.md b/packages/website/md/docs/order_watcher/1/installation.md
index 4b28f583d..4b28f583d 100644
--- a/packages/website/md/docs/order_watcher/installation.md
+++ b/packages/website/md/docs/order_watcher/1/installation.md
diff --git a/packages/website/md/docs/order_watcher/introduction.md b/packages/website/md/docs/order_watcher/1/introduction.md
index f922d922f..f922d922f 100644
--- a/packages/website/md/docs/order_watcher/introduction.md
+++ b/packages/website/md/docs/order_watcher/1/introduction.md
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.