aboutsummaryrefslogtreecommitdiffstats
path: root/packages/typescript-typings/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/typescript-typings/README.md
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/typescript-typings/README.md')
-rw-r--r--packages/typescript-typings/README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/packages/typescript-typings/README.md b/packages/typescript-typings/README.md
index 439cb6484..e3b4c044f 100644
--- a/packages/typescript-typings/README.md
+++ b/packages/typescript-typings/README.md
@@ -1,11 +1,11 @@
-## @0xproject/typescript-typings
+## @0x/typescript-typings
Type repository for external packages used by 0x. This is like our small version of [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped)
## Installation
```bash
-yarn add -D @0xproject/typescript-typings
+yarn add -D @0x/typescript-typings
```
## Usage
@@ -13,7 +13,7 @@ yarn add -D @0xproject/typescript-typings
Add the following line within an `compilerOptions` section of your `tsconfig.json`
```json
-"typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"]
+"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"]
```
This will allow the TS compiler to first look into that repo and then fallback to DT types.
@@ -43,13 +43,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/typescript-typings yarn build
+PKG=@0x/typescript-typings yarn build
```
Or continuously rebuild on change:
```bash
-PKG=@0xproject/typescript-typings yarn watch
+PKG=@0x/typescript-typings yarn watch
```
### Clean