aboutsummaryrefslogtreecommitdiffstats
path: root/packages/base-contract/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/base-contract/README.md')
-rw-r--r--packages/base-contract/README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/packages/base-contract/README.md b/packages/base-contract/README.md
index 4f2426c2e..b6ea05b74 100644
--- a/packages/base-contract/README.md
+++ b/packages/base-contract/README.md
@@ -1,25 +1,25 @@
-## @0xproject/base-contract
+## @0x/base-contract
BaseContract to derive all auto-generated wrappers from
## Installation
```bash
-yarn add @0xproject/base-contract
+yarn add @0x/base-contract
```
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"],
}
```
## Usage
```javascript
-import { BaseContract } from '@0xproject/base-contract';
+import { BaseContract } from '@0x/base-contract';
```
## Contributing
@@ -47,13 +47,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/base-contract yarn build
+PKG=@0x/base-contract yarn build
```
Or continuously rebuild on change:
```bash
-PKG=@0xproject/base-contract yarn watch
+PKG=@0x/base-contract yarn watch
```
### Lint