aboutsummaryrefslogtreecommitdiffstats
path: root/packages/assert/README.md
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2017-12-20 21:10:35 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2017-12-20 21:10:35 +0800
commitc3508dcdc6e2cf459bf076c0bb0087338cf96f7a (patch)
treebea83f7ef995c08c93d3e7877c53819ab0e7c751 /packages/assert/README.md
parent3579f063d6fb09f7a091d3f896bd29edb84b3f55 (diff)
downloaddexon-sol-tools-c3508dcdc6e2cf459bf076c0bb0087338cf96f7a.tar
dexon-sol-tools-c3508dcdc6e2cf459bf076c0bb0087338cf96f7a.tar.gz
dexon-sol-tools-c3508dcdc6e2cf459bf076c0bb0087338cf96f7a.tar.bz2
dexon-sol-tools-c3508dcdc6e2cf459bf076c0bb0087338cf96f7a.tar.lz
dexon-sol-tools-c3508dcdc6e2cf459bf076c0bb0087338cf96f7a.tar.xz
dexon-sol-tools-c3508dcdc6e2cf459bf076c0bb0087338cf96f7a.tar.zst
dexon-sol-tools-c3508dcdc6e2cf459bf076c0bb0087338cf96f7a.zip
Change CONTRIBUTING section
Diffstat (limited to 'packages/assert/README.md')
-rw-r--r--packages/assert/README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/packages/assert/README.md b/packages/assert/README.md
index 5b9b6ccab..585b4f39e 100644
--- a/packages/assert/README.md
+++ b/packages/assert/README.md
@@ -11,13 +11,17 @@ yarn add @0xproject/assert
## Usage
-TODO - Custom documentation page is in progress.
+```typescript
+import {assert} from '@0xproject/assert';
+
+assert.isValidBaseUnitAmount('baseUnitAmount', baseUnitAmount);
+```
## Contributing
We strongly encourage our community members to help us make improvements and to determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
-[CONTRIBUTING.md](../../CONTRIBUTING.md)
+Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
### Install Dependencies