Updated documentation tool (#155)

* Updated documentation tool
Added templates
Updated documentation using tool

* Fixed incorrect version in web README

* Added new templates to tool.
Updated documents in templates across the code base.
Used tool to regenerate documentation.
This commit is contained in:
Ryan O'Hara-Reid
2018-07-19 16:02:24 +10:00
committed by Adrian Gallagher
parent aaf9f52a70
commit 3b8591bcc8
148 changed files with 8201 additions and 477 deletions

View File

@@ -22,6 +22,38 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
+ This services the exchanges package by ticker functions.
+ This package facilitates ticker generation.
+ Attaches methods to an ticker
- Returns a string of a value
+ Gets a loaded ticker by exchange, asset type and currency pair.
+ This package is primarily used in conjunction with but not limited to the
exchange interface system set by exchange wrapper orderbook functions in
"exchange"_wrapper.go.
Examples below:
```go
tick, err := yobitExchange.GetTickerPrice()
if err != nil {
// Handle error
}
// Converts ticker value to string
tickerValString := tick.PriceToString(...)
```
+ or if you have a routine setting an exchange orderbook you can access it via
the package itself.
```go
tick, err := ticker.GetTicker(...)
if err != nil {
// Handle error
}
```
### Please click GoDocs chevron above to view current GoDoc information for this package
## Contribution