aboutsummaryrefslogtreecommitdiffstats
path: root/packages/contract-wrappers
diff options
context:
space:
mode:
authorJacob Evans <jacob@dekz.net>2018-10-18 19:03:47 +0800
committerJacob Evans <jacob@dekz.net>2018-10-18 19:30:09 +0800
commit2735fb4fa6901dc528aea5f642512c161b842efd (patch)
treee2fe194b2f8b627f89589c332c2d894027682062 /packages/contract-wrappers
parent88c929a408d17d8d1f4604187f8b1b04e94dab73 (diff)
downloaddexon-sol-tools-2735fb4fa6901dc528aea5f642512c161b842efd.tar
dexon-sol-tools-2735fb4fa6901dc528aea5f642512c161b842efd.tar.gz
dexon-sol-tools-2735fb4fa6901dc528aea5f642512c161b842efd.tar.bz2
dexon-sol-tools-2735fb4fa6901dc528aea5f642512c161b842efd.tar.lz
dexon-sol-tools-2735fb4fa6901dc528aea5f642512c161b842efd.tar.xz
dexon-sol-tools-2735fb4fa6901dc528aea5f642512c161b842efd.tar.zst
dexon-sol-tools-2735fb4fa6901dc528aea5f642512c161b842efd.zip
chore: change README.md from 0xproject to 0x
Diffstat (limited to 'packages/contract-wrappers')
-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