aboutsummaryrefslogtreecommitdiffstats
path: root/packages
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
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')
-rw-r--r--packages/assert/README.md8
-rw-r--r--packages/json-schemas/README.md2
-rw-r--r--packages/tslint-config/README.md2
-rw-r--r--packages/web3-wrapper/README.md2
4 files changed, 9 insertions, 5 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
diff --git a/packages/json-schemas/README.md b/packages/json-schemas/README.md
index 1621699e3..1c0d001b5 100644
--- a/packages/json-schemas/README.md
+++ b/packages/json-schemas/README.md
@@ -28,7 +28,7 @@ const isValid: boolean = validator.isValid(order, orderSchema); // Only returns
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
diff --git a/packages/tslint-config/README.md b/packages/tslint-config/README.md
index f737062b2..bbd0fb0f2 100644
--- a/packages/tslint-config/README.md
+++ b/packages/tslint-config/README.md
@@ -23,7 +23,7 @@ yarn add --dev @0xproject/tslint-config
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
diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md
index c8a984435..3624cea8c 100644
--- a/packages/web3-wrapper/README.md
+++ b/packages/web3-wrapper/README.md
@@ -17,7 +17,7 @@ TODO - Custom documentation page is in progress.
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