diff options
author | Fabio Berger <me@fabioberger.com> | 2018-08-03 17:14:01 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2018-08-03 17:14:01 +0800 |
commit | 6dd656bdfc5e9878a8a6e332b4ea844556f75d56 (patch) | |
tree | c5fb6f39b4e32142047c667006a5beca5c147813 /packages/website/md | |
parent | b5d98a280352d8f697876b35741fcf7b60b3b569 (diff) | |
download | dexon-0x-contracts-6dd656bdfc5e9878a8a6e332b4ea844556f75d56.tar dexon-0x-contracts-6dd656bdfc5e9878a8a6e332b4ea844556f75d56.tar.gz dexon-0x-contracts-6dd656bdfc5e9878a8a6e332b4ea844556f75d56.tar.bz2 dexon-0x-contracts-6dd656bdfc5e9878a8a6e332b4ea844556f75d56.tar.lz dexon-0x-contracts-6dd656bdfc5e9878a8a6e332b4ea844556f75d56.tar.xz dexon-0x-contracts-6dd656bdfc5e9878a8a6e332b4ea844556f75d56.tar.zst dexon-0x-contracts-6dd656bdfc5e9878a8a6e332b4ea844556f75d56.zip |
Add OrderWatcher docs page
Diffstat (limited to 'packages/website/md')
-rw-r--r-- | packages/website/md/docs/order_watcher/installation.md | 17 | ||||
-rw-r--r-- | packages/website/md/docs/order_watcher/introduction.md | 1 |
2 files changed, 18 insertions, 0 deletions
diff --git a/packages/website/md/docs/order_watcher/installation.md b/packages/website/md/docs/order_watcher/installation.md new file mode 100644 index 000000000..4b28f583d --- /dev/null +++ b/packages/website/md/docs/order_watcher/installation.md @@ -0,0 +1,17 @@ +**Install** + +```bash +yarn add @0xproject/order-watcher +``` + +**Import** + +```javascript +import { OrderWatcher } from '@0xproject/order-watcher'; +``` + +or + +```javascript +var OrderWatcher = require('@0xproject/order-utils').OrderWatcher; +``` diff --git a/packages/website/md/docs/order_watcher/introduction.md b/packages/website/md/docs/order_watcher/introduction.md new file mode 100644 index 000000000..f922d922f --- /dev/null +++ b/packages/website/md/docs/order_watcher/introduction.md @@ -0,0 +1 @@ +Welcome to the [@0xproject/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. |