From 53798302da8dd42bd28817bc159d235a291497a5 Mon Sep 17 00:00:00 2001
From: Fabio Berger <me@fabioberger.com>
Date: Wed, 20 Dec 2017 02:24:17 +0100
Subject: Improve subproviders readme

---
 packages/subproviders/README.md | 58 ++++++++++++++++++++++++++++++++++++-----
 1 file changed, 52 insertions(+), 6 deletions(-)

(limited to 'packages/subproviders/README.md')

diff --git a/packages/subproviders/README.md b/packages/subproviders/README.md
index 5fa31611a..73d61df42 100644
--- a/packages/subproviders/README.md
+++ b/packages/subproviders/README.md
@@ -1,15 +1,23 @@
-Subproviders
------------
+@0xproject/subproviders
+--------
 
-A few useful subproviders.
+A few useful web3 subproviders including a LedgerSubprovider useful for adding Ledger Nano S support.
 
 ## Installation
 
 ```
-npm install @0xproject/subproviders --save
+yarn add @0xproject/subproviders
 ```
 
-## Subproviders
+## Usage
+
+Simply import the subprovider you are interested in using:
+
+```javascript
+import {LedgerSubprovider} from '@0xproject/subproviders';
+```
+
+### Subproviders
 
 #### Ledger Nano S subprovider
 
@@ -23,7 +31,39 @@ A subprovider which attempts to send an RPC call to a list of RPC endpoints sequ
 
 A subprovider that relays all signing related requests to a particular provider (in our case the provider injected onto the web page), while sending all other requests to a different provider (perhaps your own backing Ethereum node or Infura).
 
-### Integration tests
+## Contributing
+
+We strongly encourage 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.
+
+Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
+
+### Install Dependencies
+
+```bash
+yarn install
+```
+
+### Build
+
+```bash
+yarn build
+```
+
+### Lint
+
+```bash
+yarn lint
+```
+
+### Run tests
+
+#### Unit tests
+
+```bash
+yarn run test:unit
+```
+
+#### Integration tests
 
 In order to run the integration tests, make sure you have a Ledger Nano S available.
 
@@ -37,3 +77,9 @@ Then run:
 ```
 yarn test:integration
 ```
+
+#### All tests
+
+```bash
+yarn run test:all
+```
-- 
cgit v1.2.3