diff options
Diffstat (limited to 'packages/assert/README.md')
| -rw-r--r-- | packages/assert/README.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/packages/assert/README.md b/packages/assert/README.md index 1f2139d47..647586f15 100644 --- a/packages/assert/README.md +++ b/packages/assert/README.md @@ -1,17 +1,17 @@ -## @0xproject/assert +## @0x/assert Standard type and schema assertions to be used across all 0x projects and packages ## Installation ```bash -yarn add @0xproject/assert +yarn add @0x/assert ``` ## Usage ```typescript -import { assert } from '@0xproject/assert'; +import { assert } from '@0x/assert'; assert.isValidBaseUnitAmount('baseUnitAmount', baseUnitAmount); ``` @@ -20,7 +20,7 @@ If your project is in [TypeScript](https://www.typescriptlang.org/), add the fol ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` @@ -49,13 +49,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/assert yarn build +PKG=@0x/assert yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/assert yarn watch +PKG=@0x/assert yarn watch ``` ### Clean |