aboutsummaryrefslogtreecommitdiffstats
path: root/packages/types/README.md
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/types/README.md
parent88c929a408d17d8d1f4604187f8b1b04e94dab73 (diff)
downloaddexon-0x-contracts-2735fb4fa6901dc528aea5f642512c161b842efd.tar
dexon-0x-contracts-2735fb4fa6901dc528aea5f642512c161b842efd.tar.gz
dexon-0x-contracts-2735fb4fa6901dc528aea5f642512c161b842efd.tar.bz2
dexon-0x-contracts-2735fb4fa6901dc528aea5f642512c161b842efd.tar.lz
dexon-0x-contracts-2735fb4fa6901dc528aea5f642512c161b842efd.tar.xz
dexon-0x-contracts-2735fb4fa6901dc528aea5f642512c161b842efd.tar.zst
dexon-0x-contracts-2735fb4fa6901dc528aea5f642512c161b842efd.zip
chore: change README.md from 0xproject to 0x
Diffstat (limited to 'packages/types/README.md')
-rw-r--r--packages/types/README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/packages/types/README.md b/packages/types/README.md
index c091b8302..136eb1940 100644
--- a/packages/types/README.md
+++ b/packages/types/README.md
@@ -1,25 +1,25 @@
-## @0xproject/types
+## @0x/types
Typescript types shared across 0x projects and packages
## Installation
```bash
-yarn add -D @0xproject/types
+yarn add -D @0x/types
```
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 { TransactionReceipt, TxData, TxDataPayable } from '@0xproject/types';
+import { TransactionReceipt, TxData, TxDataPayable } from '@0x/types';
```
## 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/types yarn build
+PKG=@0x/types yarn build
```
Or continuously rebuild on change:
```bash
-PKG=@0xproject/types yarn watch
+PKG=@0x/types yarn watch
```
### Clean