aboutsummaryrefslogtreecommitdiffstats
path: root/packages/contract-wrappers/README.md
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2018-10-18 21:46:33 +0800
committerGitHub <noreply@github.com>2018-10-18 21:46:33 +0800
commit4b95e3d6848832a06fde54b29d41d99b2a52f6ec (patch)
tree88801e5747f905b31060ebe3af7cc42a11878c34 /packages/contract-wrappers/README.md
parent9e8bca69a8a1d3570e30a28f150c0bec3848a760 (diff)
parent392d3394438fdadf4e3b4201c493e3a2921d8380 (diff)
downloaddexon-sol-tools-4b95e3d6848832a06fde54b29d41d99b2a52f6ec.tar
dexon-sol-tools-4b95e3d6848832a06fde54b29d41d99b2a52f6ec.tar.gz
dexon-sol-tools-4b95e3d6848832a06fde54b29d41d99b2a52f6ec.tar.bz2
dexon-sol-tools-4b95e3d6848832a06fde54b29d41d99b2a52f6ec.tar.lz
dexon-sol-tools-4b95e3d6848832a06fde54b29d41d99b2a52f6ec.tar.xz
dexon-sol-tools-4b95e3d6848832a06fde54b29d41d99b2a52f6ec.tar.zst
dexon-sol-tools-4b95e3d6848832a06fde54b29d41d99b2a52f6ec.zip
Merge pull request #1156 from 0xProject/feature/0x/npm-domain
Move package org from 0xproject to 0x
Diffstat (limited to 'packages/contract-wrappers/README.md')
-rw-r--r--packages/contract-wrappers/README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/packages/contract-wrappers/README.md b/packages/contract-wrappers/README.md
index 6153f798e..36f2f48fb 100644
--- a/packages/contract-wrappers/README.md
+++ b/packages/contract-wrappers/README.md
@@ -1,4 +1,4 @@
-## @0xproject/contract-wrappers
+## @0x/contract-wrappers
Smart TS wrappers for 0x smart contracts. The wrappers have simplified interfaces, perform client-side validation on transactions and throw helpful error messages.
@@ -9,20 +9,20 @@ Smart TS wrappers for 0x smart contracts. The wrappers have simplified interface
**Install**
```bash
-npm install @0xproject/contract-wrappers --save
+npm install @0x/contract-wrappers --save
```
**Import**
```javascript
-import { ContractWrappers } from '@0xproject/contract-wrappers';
+import { ContractWrappers } from '@0x/contract-wrappers';
```
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"],
}
```
@@ -51,13 +51,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/contract-wrappers yarn build
+PKG=@0x/contract-wrappers yarn build
```
Or continuously rebuild on change:
```bash
-PKG=@0xproject/contract-wrappers yarn watch
+PKG=@0x/contract-wrappers yarn watch
```
```bash