aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/md/docs
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-08-24 01:12:39 +0800
committerGitHub <noreply@github.com>2018-08-24 01:12:39 +0800
commit6e27324a341801e1a2d8d6989d749dfe021ae39b (patch)
tree32b2e1d93958905f7e4d0529e4fbead4206275ab /packages/website/md/docs
parentb013cf2e145825a9e250c61bc77825384b2af69e (diff)
parent8eb4b6f91791313dc02865a9dd3324cce646d537 (diff)
downloaddexon-sol-tools-6e27324a341801e1a2d8d6989d749dfe021ae39b.tar
dexon-sol-tools-6e27324a341801e1a2d8d6989d749dfe021ae39b.tar.gz
dexon-sol-tools-6e27324a341801e1a2d8d6989d749dfe021ae39b.tar.bz2
dexon-sol-tools-6e27324a341801e1a2d8d6989d749dfe021ae39b.tar.lz
dexon-sol-tools-6e27324a341801e1a2d8d6989d749dfe021ae39b.tar.xz
dexon-sol-tools-6e27324a341801e1a2d8d6989d749dfe021ae39b.tar.zst
dexon-sol-tools-6e27324a341801e1a2d8d6989d749dfe021ae39b.zip
Merge pull request #924 from 0xProject/wrap-typedoc
Improved Docs & Removed monorepo-scripts from packages
Diffstat (limited to 'packages/website/md/docs')
-rw-r--r--packages/website/md/docs/0xjs/2.0.0/introduction.md2
-rw-r--r--packages/website/md/docs/contract_wrappers/installation.md11
-rw-r--r--packages/website/md/docs/contract_wrappers/introduction.md3
-rw-r--r--packages/website/md/docs/order_watcher/installation.md17
-rw-r--r--packages/website/md/docs/order_watcher/introduction.md1
5 files changed, 33 insertions, 1 deletions
diff --git a/packages/website/md/docs/0xjs/2.0.0/introduction.md b/packages/website/md/docs/0xjs/2.0.0/introduction.md
index b98aeef38..d228c6855 100644
--- a/packages/website/md/docs/0xjs/2.0.0/introduction.md
+++ b/packages/website/md/docs/0xjs/2.0.0/introduction.md
@@ -1,3 +1,3 @@
<b>**NOTE:** Release candidate versions are meant to work with V2 of 0x protocol. To interact with V1, select a 0.X version.</b>
-Welcome to the [0x.js](https://github.com/0xProject/0x-monorepo) documentation! 0x.js is a Javascript library for interacting with the 0x protocol. With it, you can easily make calls to the 0x smart contracts as well as any token adhering to the token standards supported by the protocol (currently ERC20 & ERC721). Functionality includes generating, signing, filling and cancelling orders, verifying an orders signature, setting or checking a users ERC20/ERC721 token balance/allowance and much more.
+Welcome to the [0x.js](https://github.com/0xProject/0x-monorepo/tree/development/packages/0x.js) documentation! 0x.js is a Javascript library for interacting with the 0x protocol. With it, you can easily make calls to the 0x smart contracts as well as any token adhering to the token standards supported by the protocol (currently ERC20 & ERC721). Functionality includes generating, signing, filling and cancelling orders, verifying an orders signature, setting or checking a users ERC20/ERC721 token balance/allowance and much more.
diff --git a/packages/website/md/docs/contract_wrappers/installation.md b/packages/website/md/docs/contract_wrappers/installation.md
new file mode 100644
index 000000000..d5c7fbdba
--- /dev/null
+++ b/packages/website/md/docs/contract_wrappers/installation.md
@@ -0,0 +1,11 @@
+**Install**
+
+```bash
+npm install @0xproject/contract-wrappers --save
+```
+
+**Import**
+
+```javascript
+import { ContractWrappers } from '@0xproject/contract-wrappers';
+```
diff --git a/packages/website/md/docs/contract_wrappers/introduction.md b/packages/website/md/docs/contract_wrappers/introduction.md
new file mode 100644
index 000000000..74254bdad
--- /dev/null
+++ b/packages/website/md/docs/contract_wrappers/introduction.md
@@ -0,0 +1,3 @@
+<b>**NOTE:** Release candidate versions are meant to work with V2 of 0x protocol. To interact with V1, select a 0.X version.</b>
+
+Welcome to the [Contract-wrappers](https://github.com/0xProject/0x-monorepo/tree/development/packages/contract-wrappers) documentation! Contract-wrappers is a library for interacting with the Ethereum smart contracts that make up the 0x protocol. With it, you can easily send transactions and make calls to the 0x smart contracts as well as any token adhering to the token standards supported by the protocol (currently ERC20 & ERC721).
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.