aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrandon Millman <brandon.millman@gmail.com>2017-12-20 06:50:54 +0800
committerBrandon Millman <brandon.millman@gmail.com>2017-12-20 06:50:54 +0800
commitf239522a19b046b2eb3e6961ac2829dfa5d611e8 (patch)
treec0e96ee01ebecb8cf19b45799be7248fcbc98288
parentca2bb60877dbefc2e4ed07f2a437cfc89538e133 (diff)
downloaddexon-sol-tools-f239522a19b046b2eb3e6961ac2829dfa5d611e8.tar
dexon-sol-tools-f239522a19b046b2eb3e6961ac2829dfa5d611e8.tar.gz
dexon-sol-tools-f239522a19b046b2eb3e6961ac2829dfa5d611e8.tar.bz2
dexon-sol-tools-f239522a19b046b2eb3e6961ac2829dfa5d611e8.tar.lz
dexon-sol-tools-f239522a19b046b2eb3e6961ac2829dfa5d611e8.tar.xz
dexon-sol-tools-f239522a19b046b2eb3e6961ac2829dfa5d611e8.tar.zst
dexon-sol-tools-f239522a19b046b2eb3e6961ac2829dfa5d611e8.zip
Update some wording and remove N/A test sections
-rw-r--r--packages/connect/README.md4
-rw-r--r--packages/kovan-faucets/README.md17
-rw-r--r--packages/types/README.md8
-rw-r--r--packages/utils/README.md8
4 files changed, 9 insertions, 28 deletions
diff --git a/packages/connect/README.md b/packages/connect/README.md
index b6a16a16c..4326ba158 100644
--- a/packages/connect/README.md
+++ b/packages/connect/README.md
@@ -16,9 +16,9 @@ yarn add @0xproject/connect
## 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.
+We strongly recommend the community 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/kovan-faucets/README.md b/packages/kovan-faucets/README.md
index 70600fc9c..7c4177b9f 100644
--- a/packages/kovan-faucets/README.md
+++ b/packages/kovan-faucets/README.md
@@ -1,7 +1,7 @@
@0xproject/kovan_faucets
------
-This faucet dispenses 0.1 test ether to one recipient per second. It has a max queue size of 1000.
+This faucet dispenses 0.1 test ether to one recipient per second and 0.1 test ZRX every 5 seconds. It has a max queue size of 1000.
## Installation
@@ -9,9 +9,9 @@ This is a private package and therefore is not published to npm. In order to bui
## 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.
+We strongly recommend the community 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
@@ -55,13 +55,6 @@ Where recipient_address is a hex encoded Ethereum address prefixed with `0x`.
Where recipient_address is a hex encoded Ethereum address prefixed with `0x`.
-```javascript
-{
- "full": false,
- "size": 0
-}
-```
-
### Docker configs
```
@@ -82,7 +75,3 @@ kovan-faucets
```bash
yarn lint
```
-
-### Run Tests
-
-N/A
diff --git a/packages/types/README.md b/packages/types/README.md
index 3352128a3..eb27ce967 100644
--- a/packages/types/README.md
+++ b/packages/types/README.md
@@ -22,9 +22,9 @@ import {
## 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.
+We strongly recommend the community 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
@@ -49,7 +49,3 @@ yarn build
```bash
yarn lint
```
-
-### Run Tests
-
-N/A
diff --git a/packages/utils/README.md b/packages/utils/README.md
index c80c6baf5..39b6eab46 100644
--- a/packages/utils/README.md
+++ b/packages/utils/README.md
@@ -23,9 +23,9 @@ import {
## 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.
+We strongly recommend the community 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
@@ -50,7 +50,3 @@ yarn build
```bash
yarn lint
```
-
-### Run Tests
-
-N/A