Updated docs (#171)

tools/documentation/documentation.go

@@ -59,9 +59,11 @@ const (
 	coinbasepro   = "..%s..%sexchanges%scoinbasepro%s"
 	coinut        = "..%s..%sexchanges%scoinut%s"
 	exmo          = "..%s..%sexchanges%sexmo%s"
+	gateio        = "..%s..%sexchanges%sgateio%s"
 	gemini        = "..%s..%sexchanges%sgemini%s"
 	hitbtc        = "..%s..%sexchanges%shitbtc%s"
 	huobi         = "..%s..%sexchanges%shuobi%s"
+	huobihadax    = "..%s..%sexchanges%shuobihadax%s"
 	itbit         = "..%s..%sexchanges%sitbit%s"
 	kraken        = "..%s..%sexchanges%skraken%s"
 	lakebtc       = "..%s..%sexchanges%slakebtc%s"
@@ -72,6 +74,7 @@ const (
 	poloniex      = "..%s..%sexchanges%spoloniex%s"
 	wex           = "..%s..%sexchanges%swex%s"
 	yobit         = "..%s..%sexchanges%syobit%s"
+	zb            = "..%s..%sexchanges%szb%s"
 
 	contributorsList = "https://api.github.com/repos/thrasher-/gocryptotrader/contributors"
 
@@ -230,9 +233,11 @@ func addPaths() {
 	codebasePaths["exchanges coinut"] = fmt.Sprintf(coinut, path, path, path, path)
 	codebasePaths["exchanges exmo"] = fmt.Sprintf(exmo, path, path, path, path)
 	codebasePaths["exchanges coinbasepro"] = fmt.Sprintf(coinbasepro, path, path, path, path)
+	codebasePaths["exchanges gateio"] = fmt.Sprintf(gateio, path, path, path, path)
 	codebasePaths["exchanges gemini"] = fmt.Sprintf(gemini, path, path, path, path)
 	codebasePaths["exchanges hitbtc"] = fmt.Sprintf(hitbtc, path, path, path, path)
 	codebasePaths["exchanges huobi"] = fmt.Sprintf(huobi, path, path, path, path)
+	codebasePaths["exchanges huobihadax"] = fmt.Sprintf(huobihadax, path, path, path, path)
 	codebasePaths["exchanges itbit"] = fmt.Sprintf(itbit, path, path, path, path)
 	codebasePaths["exchanges kraken"] = fmt.Sprintf(kraken, path, path, path, path)
 	codebasePaths["exchanges lakebtc"] = fmt.Sprintf(lakebtc, path, path, path, path)
@@ -243,6 +248,7 @@ func addPaths() {
 	codebasePaths["exchanges poloniex"] = fmt.Sprintf(poloniex, path, path, path, path)
 	codebasePaths["exchanges wex"] = fmt.Sprintf(wex, path, path, path, path)
 	codebasePaths["exchanges yobit"] = fmt.Sprintf(yobit, path, path, path, path)
+	codebasePaths["exchanges zb"] = fmt.Sprintf(zb, path, path, path, path)
 
 	codebasePaths["CONTRIBUTORS"] = fmt.Sprintf(rootPath, path, path)
 	codebasePaths["LICENSE"] = fmt.Sprintf(rootPath, path, path)

tools/documentation/exchanges_templates/gateio.tmpl

@@ -0,0 +1,105 @@
+{{define "exchanges gateio" -}}
+{{template "header" .}}
+## GateIO Exchange
+
+### Current Features
+
++ REST functions
+
+### How to enable
+
++ [Enable via configuration](https://github.com/thrasher-/gocryptotrader/tree/master/config#enable-exchange-via-config-example)
+
++ Individual package example below:
+
+```go
+  // Exchanges will be abstracted out in further updates and examples will be
+  // supplied then
+```
+
+### How to do REST public/private calls
+
++ If enabled via "configuration".json file the exchange will be added to the
+IBotExchange array in the ```go var bot Bot``` and you will only be able to use
+the wrapper interface functions for accessing exchange data. View routines.go
+for an example of integration usage with GoCryptoTrader. Rudimentary example
+below:
+
+main.go
+```go
+var g exchange.IBotExchange
+
+for i := range bot.exchanges {
+  if bot.exchanges[i].GetName() == "GateIO" {
+    g = bot.exchanges[i]
+  }
+}
+
+// Public calls - wrapper functions
+
+// Fetches current ticker information
+tick, err := g.GetTickerPrice()
+if err != nil {
+  // Handle error
+}
+
+// Fetches current orderbook information
+ob, err := g.GetOrderbookEx()
+if err != nil {
+  // Handle error
+}
+
+// Private calls - wrapper functions - make sure your APIKEY and APISECRET are
+// set and AuthenticatedAPISupport is set to true
+
+// Fetches current account information
+accountInfo, err := g.GetExchangeAccountInfo()
+if err != nil {
+  // Handle error
+}
+```
+
++ If enabled via individually importing package, rudimentary example below:
+
+```go
+// Public calls
+
+// Fetches current ticker information
+ticker, err := g.GetTicker()
+if err != nil {
+  // Handle error
+}
+
+// Fetches current orderbook information
+ob, err := g.GetOrderBook()
+if err != nil {
+  // Handle error
+}
+
+// Private calls - make sure your APIKEY and APISECRET are set and
+// AuthenticatedAPISupport is set to true
+
+// GetUserInfo returns account info
+accountInfo, err := g.GetUserInfo(...)
+if err != nil {
+  // Handle error
+}
+
+// Submits an order and the exchange and returns its tradeID
+tradeID, err := g.Trade(...)
+if err != nil {
+  // Handle error
+}
+```
+
+### How to do LongPolling public/private calls
+
+```go
+  // Exchanges will be abstracted out in further updates and examples will be
+  // supplied then
+```
+
+### Please click GoDocs chevron above to view current GoDoc information for this package
+{{template "contributions"}}
+{{template "donations"}}
+{{end}}

tools/documentation/exchanges_templates/huobihadax.tmpl

@@ -0,0 +1,105 @@
+{{define "exchanges huobihadax" -}}
+{{template "header" .}}
+## HuobiHadax Exchange
+
+### Current Features
+
++ REST functions
+
+### How to enable
+
++ [Enable via configuration](https://github.com/thrasher-/gocryptotrader/tree/master/config#enable-exchange-via-config-example)
+
++ Individual package example below:
+
+```go
+  // Exchanges will be abstracted out in further updates and examples will be
+  // supplied then
+```
+
+### How to do REST public/private calls
+
++ If enabled via "configuration".json file the exchange will be added to the
+IBotExchange array in the ```go var bot Bot``` and you will only be able to use
+the wrapper interface functions for accessing exchange data. View routines.go
+for an example of integration usage with GoCryptoTrader. Rudimentary example
+below:
+
+main.go
+```go
+var h exchange.IBotExchange
+
+for i := range bot.exchanges {
+  if bot.exchanges[i].GetName() == "HuobiHadax" {
+    h = bot.exchanges[i]
+  }
+}
+
+// Public calls - wrapper functions
+
+// Fetches current ticker information
+tick, err := h.GetTickerPrice()
+if err != nil {
+  // Handle error
+}
+
+// Fetches current orderbook information
+ob, err := h.GetOrderbookEx()
+if err != nil {
+  // Handle error
+}
+
+// Private calls - wrapper functions - make sure your APIKEY and APISECRET are
+// set and AuthenticatedAPISupport is set to true
+
+// Fetches current account information
+accountInfo, err := h.GetExchangeAccountInfo()
+if err != nil {
+  // Handle error
+}
+```
+
++ If enabled via individually importing package, rudimentary example below:
+
+```go
+// Public calls
+
+// Fetches current ticker information
+ticker, err := h.GetTicker()
+if err != nil {
+  // Handle error
+}
+
+// Fetches current orderbook information
+ob, err := h.GetOrderBook()
+if err != nil {
+  // Handle error
+}
+
+// Private calls - make sure your APIKEY and APISECRET are set and
+// AuthenticatedAPISupport is set to true
+
+// GetUserInfo returns account info
+accountInfo, err := h.GetUserInfo(...)
+if err != nil {
+  // Handle error
+}
+
+// Submits an order and the exchange and returns its tradeID
+tradeID, err := h.Trade(...)
+if err != nil {
+  // Handle error
+}
+```
+
+### How to do LongPolling public/private calls
+
+```go
+  // Exchanges will be abstracted out in further updates and examples will be
+  // supplied then
+```
+
+### Please click GoDocs chevron above to view current GoDoc information for this package
+{{template "contributions"}}
+{{template "donations"}}
+{{end}}

tools/documentation/exchanges_templates/zb.tmpl

@@ -0,0 +1,105 @@
+{{define "exchanges zb" -}}
+{{template "header" .}}
+## ZB Exchange
+
+### Current Features
+
++ REST functions
+
+### How to enable
+
++ [Enable via configuration](https://github.com/thrasher-/gocryptotrader/tree/master/config#enable-exchange-via-config-example)
+
++ Individual package example below:
+
+```go
+  // Exchanges will be abstracted out in further updates and examples will be
+  // supplied then
+```
+
+### How to do REST public/private calls
+
++ If enabled via "configuration".json file the exchange will be added to the
+IBotExchange array in the ```go var bot Bot``` and you will only be able to use
+the wrapper interface functions for accessing exchange data. View routines.go
+for an example of integration usage with GoCryptoTrader. Rudimentary example
+below:
+
+main.go
+```go
+var z exchange.IBotExchange
+
+for i := range bot.exchanges {
+  if bot.exchanges[i].GetName() == "ZB" {
+    z = bot.exchanges[i]
+  }
+}
+
+// Public calls - wrapper functions
+
+// Fetches current ticker information
+tick, err := z.GetTickerPrice()
+if err != nil {
+  // Handle error
+}
+
+// Fetches current orderbook information
+ob, err := z.GetOrderbookEx()
+if err != nil {
+  // Handle error
+}
+
+// Private calls - wrapper functions - make sure your APIKEY and APISECRET are
+// set and AuthenticatedAPISupport is set to true
+
+// Fetches current account information
+accountInfo, err := z.GetExchangeAccountInfo()
+if err != nil {
+  // Handle error
+}
+```
+
++ If enabled via individually importing package, rudimentary example below:
+
+```go
+// Public calls
+
+// Fetches current ticker information
+ticker, err := z.GetTicker()
+if err != nil {
+  // Handle error
+}
+
+// Fetches current orderbook information
+ob, err := z.GetOrderBook()
+if err != nil {
+  // Handle error
+}
+
+// Private calls - make sure your APIKEY and APISECRET are set and
+// AuthenticatedAPISupport is set to true
+
+// GetUserInfo returns account info
+accountInfo, err := z.GetUserInfo(...)
+if err != nil {
+  // Handle error
+}
+
+// Submits an order and the exchange and returns its tradeID
+tradeID, err := z.Trade(...)
+if err != nil {
+  // Handle error
+}
+```
+
+### How to do LongPolling public/private calls
+
+```go
+  // Exchanges will be abstracted out in further updates and examples will be
+  // supplied then
+```
+
+### Please click GoDocs chevron above to view current GoDoc information for this package
+{{template "contributions"}}
+{{template "donations"}}
+{{end}}