diff options
Diffstat (limited to 'packages/0x.js/README.md')
| -rw-r--r-- | packages/0x.js/README.md | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/packages/0x.js/README.md b/packages/0x.js/README.md index fd6217151..5b7a2308c 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,14 +19,21 @@ 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`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` |