aboutsummaryrefslogtreecommitdiffstats
path: root/packages/0x.js/README.md
diff options
context:
space:
mode:
authorJacob Evans <jacob@dekz.net>2018-09-13 19:51:09 +0800
committerJacob Evans <jacob@dekz.net>2018-09-13 19:58:05 +0800
commitcf46d2c7049461e25441239e71f486bfbd2a986a (patch)
treeebed0751305adb60c74ec6691e360b331f1a26f1 /packages/0x.js/README.md
parentdf5779b6d1a81f85b91c57fd2948ded91c1a07d7 (diff)
downloaddexon-sol-tools-cf46d2c7049461e25441239e71f486bfbd2a986a.tar
dexon-sol-tools-cf46d2c7049461e25441239e71f486bfbd2a986a.tar.gz
dexon-sol-tools-cf46d2c7049461e25441239e71f486bfbd2a986a.tar.bz2
dexon-sol-tools-cf46d2c7049461e25441239e71f486bfbd2a986a.tar.lz
dexon-sol-tools-cf46d2c7049461e25441239e71f486bfbd2a986a.tar.xz
dexon-sol-tools-cf46d2c7049461e25441239e71f486bfbd2a986a.tar.zst
dexon-sol-tools-cf46d2c7049461e25441239e71f486bfbd2a986a.zip
0xjs README/website docs update
Diffstat (limited to 'packages/0x.js/README.md')
-rw-r--r--packages/0x.js/README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/packages/0x.js/README.md b/packages/0x.js/README.md
index fd6217151..329037324 100644
--- a/packages/0x.js/README.md
+++ b/packages/0x.js/README.md
@@ -1,6 +1,6 @@
## 0x.js
-A TypeScript/Javascript library for interacting with the 0x protocol.
+A TypeScript/Javascript library for interacting with the 0x protocol. It is a high level package which combines a number of underlying packages such as order-utils and order-watcher.
### Read the [Documentation](https://0xproject.com/docs/0x.js).
@@ -19,7 +19,14 @@ npm install 0x.js --save
**Import**
```javascript
-import { ZeroEx } from '0x.js';
+import {
+ assetDataUtils,
+ BigNumber,
+ ContractWrappers,
+ generatePseudoRandomSalt,
+ orderHashUtils,
+ signatureUtils,
+} from '0x.js';
```
If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: