aboutsummaryrefslogtreecommitdiffstats
path: root/packages/instant/README.md
diff options
context:
space:
mode:
authorfragosti <francesco.agosti93@gmail.com>2018-10-20 00:18:43 +0800
committerfragosti <francesco.agosti93@gmail.com>2018-10-20 00:19:37 +0800
commit6f2217570f0dd7060cf208da32b18c52c9798871 (patch)
tree0bd34b345ef58cc6156f700b93b44cd5f32ea420 /packages/instant/README.md
parent91ca80b248ac75b0d8258dd4dfc7a6e0c36c572b (diff)
parent669ea191a5e34ec704851377ee5eedb03c2d1538 (diff)
downloaddexon-sol-tools-6f2217570f0dd7060cf208da32b18c52c9798871.tar.gz
dexon-sol-tools-6f2217570f0dd7060cf208da32b18c52c9798871.tar.zst
dexon-sol-tools-6f2217570f0dd7060cf208da32b18c52c9798871.zip
Merge branch 'development' of https://github.com/0xProject/0x-monorepo into feature/instant/discharge
Diffstat (limited to 'packages/instant/README.md')
-rw-r--r--packages/instant/README.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/packages/instant/README.md b/packages/instant/README.md
index 2437835c8..07b01ac95 100644
--- a/packages/instant/README.md
+++ b/packages/instant/README.md
@@ -1,9 +1,9 @@
-## @0xproject/instant
+## @0x/instant
## Installation
```bash
-yarn add @0xproject/instant
+yarn add @0x/instant
```
**Import**
@@ -11,20 +11,20 @@ yarn add @0xproject/instant
**CommonJS module**
```typescript
-import { ZeroExInstant } from '@0xproject/instant';
+import { ZeroExInstant } from '@0x/instant';
```
or
```javascript
-var ZeroExInstant = require('@0xproject/instant').ZeroExInstant;
+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/@0xproject/typescript-typings/types", "node_modules/@types"],
+ "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
```
@@ -83,13 +83,13 @@ yarn install
To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
```bash
-PKG=@0xproject/instant yarn build
+PKG=@0x/instant yarn build
```
Or continuously rebuild on change:
```bash
-PKG=@0xproject/instant yarn watch
+PKG=@0x/instant yarn watch
```
### Clean