Add contributor and version badges; update reference docs

macchado · Sep 27, 2017 · f319979 · f319979
1 parent 5ae1795
commit f319979
Show file tree

Hide file tree

Showing 218 changed files with 2,454 additions and 1,600 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,9 @@
 # GDAX Trading toolkit
+
+<!-- ⛔️ AUTO-GENERATED-CONTENT:START (VERSIONBADGE) -->
+[![npm](https://img.shields.io/badge/npm-v0.1.16-green.svg)](https://www.npmjs.com/package/gdax-trading-toolkit)
+<!-- ⛔️ AUTO-GENERATED-CONTENT:END -->
+
 Provide all the tools traders need, both professional and hobbyist alike, to create automated trading bots on the
 GDAX and supported digital asset exchanges. Note: Node 7.6 or above is required.
 
@@ -29,3 +34,20 @@ authors, copyright holders, or Coinbase Inc. be liable for any claim, damages or
 liability, whether in an action of contract, tort or otherwise, arising from,
 out of or in connection with the software or the use or other dealings in the
 software.
+
+# Contributors
+
+<!-- ⛔️ AUTO-GENERATED-CONTENT:START (CONTRIBUTORS) -->
+| **Commits** | **Contributor** |  
+| --- | --- |  
+| 13 | [CjS77](https://github.com/CjS77) |  
+| 3  | [mihar](https://github.com/mihar) |  
+| 2  | [kostola](https://github.com/kostola) |  
+| 1  | [abe238](https://github.com/abe238) |  
+| 1  | [fb55](https://github.com/fb55) |  
+| 1  | [discosultan](https://github.com/discosultan) |  
+| 1  | [maxbeatty](https://github.com/maxbeatty) |  
+| 1  | [pzagor2](https://github.com/pzagor2) |  
+| 1  | [jcronq](https://github.com/jcronq) |  
+
+<!-- ⛔️ AUTO-GENERATED-CONTENT:END -->
diff --git a/docs/apiref/assets/js/search.js b/docs/apiref/assets/js/search.js
diff --git a/docs/apiref/classes/_src_core_exchangeratefilter_.exchangeratefilter.html b/docs/apiref/classes/_src_core_exchangeratefilter_.exchangeratefilter.html
@@ -178,7 +178,7 @@ <h3>constructor</h3>
 							<aside class="tsd-sources">
 								<p>Overrides <a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html">AbstractMessageTransform</a>.<a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html#constructor">constructor</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/94482f1/src/core/ExchangeRateFilter.ts#L41">src/core/ExchangeRateFilter.ts:41</a></li>
+									<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/5ae1795/src/core/ExchangeRateFilter.ts#L41">src/core/ExchangeRateFilter.ts:41</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -200,7 +200,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> fx<wbr>Service</h3>
 					<div class="tsd-signature tsd-kind-icon">fx<wbr>Service<span class="tsd-signature-symbol">:</span> <a href="_src_fxservice_fxservice_.fxservice.html" class="tsd-signature-type">FXService</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/94482f1/src/core/ExchangeRateFilter.ts#L40">src/core/ExchangeRateFilter.ts:40</a></li>
+							<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/5ae1795/src/core/ExchangeRateFilter.ts#L40">src/core/ExchangeRateFilter.ts:40</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -211,7 +211,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> logger</h3>
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html">AbstractMessageTransform</a>.<a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html#logger">logger</a></p>
 						<ul>
-							<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/94482f1/src/lib/AbstractMessageTransform.ts#L29">src/lib/AbstractMessageTransform.ts:29</a></li>
+							<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/5ae1795/src/lib/AbstractMessageTransform.ts#L29">src/lib/AbstractMessageTransform.ts:29</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -221,7 +221,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> pair</h3>
 					<div class="tsd-signature tsd-kind-icon">pair<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_src_fxservice_fxprovider_.currencypair.html" class="tsd-signature-type">CurrencyPair</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/94482f1/src/core/ExchangeRateFilter.ts#L39">src/core/ExchangeRateFilter.ts:39</a></li>
+							<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/5ae1795/src/core/ExchangeRateFilter.ts#L39">src/core/ExchangeRateFilter.ts:39</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -231,7 +231,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> pair<wbr>Index</h3>
 					<div class="tsd-signature tsd-kind-icon">pair<wbr>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/94482f1/src/core/ExchangeRateFilter.ts#L38">src/core/ExchangeRateFilter.ts:38</a></li>
+							<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/5ae1795/src/core/ExchangeRateFilter.ts#L38">src/core/ExchangeRateFilter.ts:38</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -241,7 +241,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> precision</h3>
 					<div class="tsd-signature tsd-kind-icon">precision<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/94482f1/src/core/ExchangeRateFilter.ts#L41">src/core/ExchangeRateFilter.ts:41</a></li>
+							<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/5ae1795/src/core/ExchangeRateFilter.ts#L41">src/core/ExchangeRateFilter.ts:41</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -302,7 +302,7 @@ <h3>rate</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/94482f1/src/core/ExchangeRateFilter.ts#L51">src/core/ExchangeRateFilter.ts:51</a></li>
+									<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/5ae1795/src/core/ExchangeRateFilter.ts#L51">src/core/ExchangeRateFilter.ts:51</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <a href="../interfaces/_src_fxservice_fxprovider_.fxobject.html" class="tsd-signature-type">FXObject</a></h4>
@@ -348,7 +348,7 @@ <h3>_transform</h3>
 								<p>Inherited from <a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html">AbstractMessageTransform</a>.<a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html#_transform">_transform</a></p>
 								<p>Overrides Transform._transform</p>
 								<ul>
-									<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/94482f1/src/lib/AbstractMessageTransform.ts#L47">src/lib/AbstractMessageTransform.ts:47</a></li>
+									<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/5ae1795/src/lib/AbstractMessageTransform.ts#L47">src/lib/AbstractMessageTransform.ts:47</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -426,7 +426,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> apply<wbr>Rate</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/94482f1/src/core/ExchangeRateFilter.ts#L82">src/core/ExchangeRateFilter.ts:82</a></li>
+									<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/5ae1795/src/core/ExchangeRateFilter.ts#L82">src/core/ExchangeRateFilter.ts:82</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -625,7 +625,7 @@ <h3>log</h3>
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html">AbstractMessageTransform</a>.<a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html#log">log</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/94482f1/src/lib/AbstractMessageTransform.ts#L36">src/lib/AbstractMessageTransform.ts:36</a></li>
+									<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/5ae1795/src/lib/AbstractMessageTransform.ts#L36">src/lib/AbstractMessageTransform.ts:36</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -851,7 +851,7 @@ <h3>read</h3>
 								<p>Inherited from <a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html">AbstractMessageTransform</a>.<a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html#read">read</a></p>
 								<p>Overrides Transform.read</p>
 								<ul>
-									<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/94482f1/src/lib/AbstractMessageTransform.ts#L43">src/lib/AbstractMessageTransform.ts:43</a></li>
+									<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/5ae1795/src/lib/AbstractMessageTransform.ts#L43">src/lib/AbstractMessageTransform.ts:43</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -995,7 +995,7 @@ <h3>transform<wbr>Message</h3>
 							<aside class="tsd-sources">
 								<p>Overrides <a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html">AbstractMessageTransform</a>.<a href="_src_lib_abstractmessagetransform_.abstractmessagetransform.html#transformmessage">transformMessage</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/94482f1/src/core/ExchangeRateFilter.ts#L67">src/core/ExchangeRateFilter.ts:67</a></li>
+									<li>Defined in <a href="https://github.com/coinbase/gdax-tt/blob/5ae1795/src/core/ExchangeRateFilter.ts#L67">src/core/ExchangeRateFilter.ts:67</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>