adding better intro documentation

Author: TrevorJTClarke

docs/api.md

@@ -547,46 +547,6 @@ const metrics = await web3data.address.getMetrics('0x3f5ce5fbfe3e9af3971dd833d26
 
 
 
-### src/bch.js
-
-
-#### new Bch()  *private method*
-
-Class for all Bitcoin Cash based methods.
-
-
-
-
-
-
-##### Returns
-
-
-- `Void`
-
-
-
-
-### src/bsv.js
-
-
-#### new Bsv()  *private method*
-
-Class for all Bitcoin SV based methods.
-
-
-
-
-
-
-##### Returns
-
-
-- `Void`
-
-
-
-
 ### src/block.js
 
 
@@ -924,6 +884,26 @@ Retrieves the blocks metrics & statistics. If no DateRange is specified, it will
 
 
 
+### src/bch.js
+
+
+#### new Bch()  *private method*
+
+Class for all Bitcoin Cash based methods.
+
+
+
+
+
+
+##### Returns
+
+
+- `Void`
+
+
+
+
 ### src/blockchain.js
 
 
@@ -988,6 +968,26 @@ const metrics = await web3data.blockchain.getMetrics()
 
 
 
+### src/bsv.js
+
+
+#### new Bsv()  *private method*
+
+Class for all Bitcoin SV based methods.
+
+
+
+
+
+
+##### Returns
+
+
+- `Void`
+
+
+
+
 ### src/btc.js
 
 
@@ -1220,6 +1220,26 @@ Class for all Ethereum based methods.
 
 
 
+##### Returns
+
+
+- `Void`
+
+
+
+
+### src/ltc.js
+
+
+#### new Ltc()  *private method*
+
+Class for all Litecoin based methods.
+
+
+
+
+
+
 ##### Returns
 
 
@@ -1644,26 +1664,6 @@ const batTokenAddress = web3data.market.getAssetAddresses('bat') const assetAddr
 
 
 
-### src/ltc.js
-
-
-#### new Ltc()  *private method*
-
-Class for all Litecoin based methods.
-
-
-
-
-
-
-##### Returns
-
-
-- `Void`
-
-
-
-
 ### src/signature.js
 
 
@@ -3145,12 +3145,12 @@ Sends unsubscription message to the websocket connection.
 
 
 
-### src/zec.js
+### src/xlm.js
 
 
-#### new Zec()  *private method*
+#### new Xlm()  *private method*
 
-Class for all ZCash based methods.
+Class for all Stellar based methods.
 
 
 
@@ -3165,12 +3165,12 @@ Class for all ZCash based methods.
 
 
 
-### src/xlm.js
+### src/zec.js
 
 
-#### new Xlm()  *private method*
+#### new Zec()  *private method*
 
-Class for all Stellar based methods.
+Class for all ZCash based methods.
 
 
 

docs/quick-start.md

@@ -1,5 +1,12 @@
 ![Web3data.js Javascript API](./assets/web3data-js-logo-banner.png)
 
+[![Build Status](https://travis-ci.com/web3data/web3data-js.svg?branch=master)](https://travis-ci.com/web3data/web3data-js)
+[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)
+[![Try web3data-js on RunKit](https://badge.runkitcdn.com/web3data-js.svg)](https://npm.runkit.com/web3data-js)
+
+# Web3data.js Javascript API
+Wrapper for [Amberdata.io](http://amberdata.io)'s [REST API](http://docs.amberdata.io/reference)
+
 ## Installation
 <i>Note that you must have node (and npm) installed.</i>
 
@@ -13,6 +20,17 @@ Using CDN:
 <script src="https://unpkg.com/web3data-js/dist/web3data.min.js"></script>
 ```
 
+## The API Key
+Visit [Amberdata.io](https://amberdata.io/pricing) and select the developer plan to get started!
+
+Once you've got your key, place it in a file named `.env` &mdash; see [env.example](./env.example) for reference.
+
+Then in you code you can use it like so:
+
+```javascript
+const web3Data = new Web3Data(process.env.API_KEY)
+```
+
 ## Configuration
 Web3data configuration is simple and only requires an API Key upon instantiation.
 ```javascript
@@ -30,11 +48,83 @@ requests via web3data.js.
 
 You can find the full [list of blockchain IDs](https://docs.amberdata.io/reference#blockchain-ids) in our docs.
 
+
+## Simple Usage Example
+
+For more examples, [click here to head over to view more quick examples](/examples). For a full spectrum of guides, tutorials & sample code, go to [our Amberdata Documentation](https://amberdata.io/docs). For filters & optional parameters, please [refer to the API documentation](https://docs.amberdata.io).
+
+#### Within Node
+```js
+import Web3Data from 'web3data-js'
+
+const w3d = new Web3Data('<api-key>')
+
+;( async () => {
+     const contract = await w3d.contract.getDetails("0x06012c8cf97bead5deae237070f9587f8e7a266d")
+     console.log(contract) // { ... }
+})()
+```
+
+#### Websockets Events
+```js
+import Web3Data from 'web3data-js'
+
+const w3d = new Web3Data('<api-key>')
+
+w3d.connect(status => {
+  console.log('status ->', status.type)
+})
+w3d.on({eventName: 'block'}, data => {
+  console.log(data)
+})
+```
+
 ## Blockchains/Networks
 It's possible to the namespace convention to specify which blockchain to use when making requests.
 This makes it easier to switch between blockchains as Web3data will automatically set the correct headers under
 the hood.
 
+### Supported Blockchain Namespaces
+
+<table style="width:100%">
+  <tr>
+    <th>Name</th>
+    <th>Namespace</th>
+  </tr>
+  <tr>
+    <td>default</td>
+    <td>web3data.* (Ethereum)</td>
+  </tr>
+  <tr>
+    <td>Bitcoin</td>
+    <td>web3data.btc</td>
+  </tr>
+  <tr>
+    <td>Ethereum</td>
+    <td>web3data.eth</td>
+  </tr>
+  <tr>
+    <td>Litecoin</td>
+    <td>web3data.ltc</td>
+  </tr>
+  <tr>
+    <td>Bitcoin Cash</td>
+    <td>web3data.bch</td>
+  </tr>
+  <tr>
+    <td>Bitcoin SV</td>
+    <td>web3data.bsv</td>
+  </tr>
+  <tr>
+    <td>Stellar</td>
+    <td>web3data.xlm</td>
+  </tr>
+  <tr>
+    <td>Zcash</td>
+    <td>web3data.zec</td>
+  </tr>
+</table>
+
 ### Ethereum
 
 **Namespace**: `.eth`
@@ -74,29 +164,42 @@ web3data.eth.address.getBalance('0x734Ac651Dd95a339c633cdEd410228515F97fAfF')
   <tr>
     <td>getTransactions</td>
     <td>getTransactions</td>
+    <td></td>
   </tr>
   <tr>
     <td>getPendingTransactions</td>
     <td>getTransactionFromBlock</td>
+    <td></td>
   </tr>
   <tr>
     <td>getBalance</td>
     <td>getMetrics</td>
+    <td></td>
   </tr>
   <tr>
     <td>getLatestBalance</td>
+    <td></td>
+    <td></td>
   </tr>
   <tr>
     <td>getHistoricalBalance</td>
+    <td></td>
+    <td></td>
   </tr>
   <tr>
     <td>getMultipleBalances</td>
+    <td></td>
+    <td></td>
   </tr>
   <tr>
     <td>getBalancesBatch</td>
+    <td></td>
+    <td></td>
   </tr>
   <tr>
     <td>getMetrics</td>
+    <td></td>
+    <td></td>
   </tr>
 </table>
 </details>