diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-10-19 00:31:38 +0800 |
|---|---|---|
| committer | Fabio Berger <me@fabioberger.com> | 2018-10-19 00:31:38 +0800 |
| commit | c4ae91c7c5aaa2d6e278448667bf828162be93bc (patch) | |
| tree | 46843ed4273b158e0313897d2b5029516c4222ba /packages/website/md/docs/order_watcher | |
| parent | 8b62b350b1fed6a0d8827ca9ed5fcec3e78ae82f (diff) | |
| download | dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.gz dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.bz2 dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.lz dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.xz dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.zst dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.zip | |
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.md | 17 | ||||
| -rw-r--r-- | packages/website/md/docs/order_watcher/2/introduction.md | 1 |
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. |