aboutsummaryrefslogtreecommitdiffstats
path: root/packages/assert/README.md
diff options
context:
space:
mode:
authorAugust Skare <post@augustskare.no>2018-11-13 16:52:41 +0800
committerAugust Skare <post@augustskare.no>2018-11-13 16:52:41 +0800
commite43988aa44225ef66c95d0b26764de57b3d26c3a (patch)
tree5f2bdff05e3e6a336b600bcb7a766da4793afc76 /packages/assert/README.md
parentee91f56bbe69534885da47f58a81302bf3c37f28 (diff)
parentc41622c20aea8ba89dc9899ff8b3ab6f22f53503 (diff)
downloaddexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar
dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar.gz
dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar.bz2
dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar.lz
dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar.xz
dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar.zst
dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.zip
Merge branch 'development' into dev-tools-pages
Diffstat (limited to 'packages/assert/README.md')
-rw-r--r--packages/assert/README.md12
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