From c3508dcdc6e2cf459bf076c0bb0087338cf96f7a Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Wed, 20 Dec 2017 14:10:35 +0100 Subject: Change CONTRIBUTING section --- packages/assert/README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'packages/assert/README.md') 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 -- cgit v1.2.3