aboutsummaryrefslogtreecommitdiffstats
path: root/packages/kovan-faucets/README.md
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2018-01-10 18:23:03 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2018-01-10 18:23:03 +0800
commita767c353d25588cf5802868ee7b3710e99316e96 (patch)
treea4d2bbf93e082a719007f8cc5903ce2028fd32b2 /packages/kovan-faucets/README.md
parenta39d3d723399e124ae617dfda67e754907312a98 (diff)
parentc700046b7673a0f470c8d8abeec3cf873049a78a (diff)
downloaddexon-sol-tools-a767c353d25588cf5802868ee7b3710e99316e96.tar
dexon-sol-tools-a767c353d25588cf5802868ee7b3710e99316e96.tar.gz
dexon-sol-tools-a767c353d25588cf5802868ee7b3710e99316e96.tar.bz2
dexon-sol-tools-a767c353d25588cf5802868ee7b3710e99316e96.tar.lz
dexon-sol-tools-a767c353d25588cf5802868ee7b3710e99316e96.tar.xz
dexon-sol-tools-a767c353d25588cf5802868ee7b3710e99316e96.tar.zst
dexon-sol-tools-a767c353d25588cf5802868ee7b3710e99316e96.zip
Merge branch 'fix/prettify_json' into development
Diffstat (limited to 'packages/kovan-faucets/README.md')
-rw-r--r--packages/kovan-faucets/README.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/packages/kovan-faucets/README.md b/packages/kovan-faucets/README.md
index 111e88302..07bd23575 100644
--- a/packages/kovan-faucets/README.md
+++ b/packages/kovan-faucets/README.md
@@ -1,5 +1,4 @@
-@0xproject/kovan_faucets
-------
+## @0xproject/kovan_faucets
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.
@@ -16,11 +15,13 @@ Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting
### Install Dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
+
```bash
yarn config set workspaces-experimental true
```
Then install dependencies
+
```bash
yarn install
```
@@ -47,11 +48,11 @@ yarn dev
### Endpoints
-```GET /ether/:recipient```
+`GET /ether/:recipient`
Where recipient_address is a hex encoded Ethereum address prefixed with `0x`.
-```GET /zrx/:recipient```
+`GET /zrx/:recipient`
Where recipient_address is a hex encoded Ethereum address prefixed with `0x`.