diff options
| author | fragosti <francesco.agosti93@gmail.com> | 2018-11-27 06:37:21 +0800 |
|---|---|---|
| committer | fragosti <francesco.agosti93@gmail.com> | 2018-11-27 06:37:21 +0800 |
| commit | 35d8525f5563e877752fd1bd9e5a5c7ffa395b78 (patch) | |
| tree | 2abbbc2d28053a6327fce8502720022141694cc3 /packages/instant/README.md | |
| parent | faf80f85959ce157435f3bd500b00fd33e828084 (diff) | |
| download | dexon-sol-tools-35d8525f5563e877752fd1bd9e5a5c7ffa395b78.tar dexon-sol-tools-35d8525f5563e877752fd1bd9e5a5c7ffa395b78.tar.gz dexon-sol-tools-35d8525f5563e877752fd1bd9e5a5c7ffa395b78.tar.bz2 dexon-sol-tools-35d8525f5563e877752fd1bd9e5a5c7ffa395b78.tar.lz dexon-sol-tools-35d8525f5563e877752fd1bd9e5a5c7ffa395b78.tar.xz dexon-sol-tools-35d8525f5563e877752fd1bd9e5a5c7ffa395b78.tar.zst dexon-sol-tools-35d8525f5563e877752fd1bd9e5a5c7ffa395b78.zip | |
feat: update README to reflect lack of commonjs module
Diffstat (limited to 'packages/instant/README.md')
| -rw-r--r-- | packages/instant/README.md | 30 |
1 files changed, 1 insertions, 29 deletions
diff --git a/packages/instant/README.md b/packages/instant/README.md index b83a10508..fd94d37d1 100644 --- a/packages/instant/README.md +++ b/packages/instant/README.md @@ -2,35 +2,7 @@ ## Installation -```bash -yarn add @0x/instant -``` - -**Import** - -**CommonJS module** - -```typescript -import { ZeroExInstant } from '@0x/instant'; -``` - -or - -```javascript -var ZeroExInstant = require('@0x/instant').ZeroExInstant; -``` - -If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: - -```json -"compilerOptions": { - "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], -} -``` - -**UMD Module** - -The package is also available as a UMD module named `zeroExInstant`. +The package is available as a UMD module named `zeroExInstant`. ```html <head> |