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

@@ -0,0 +1,20 @@
{{define "tools config" -}}
{{template "header" .}}
## Configuration management tool
### Current Features
+ The configuration management tool takes in a "configuration".json file and
writes to an output file while validating the inputting data.
Example usage:
```bash
cd $GOPATH/src/github.com/thrasher-/gocryptotrader/tools/config/
go run ./config.go -infile path/of/config.json -outfile path/of/new/config.json -encrypt falseOrTrue -key KEYHERE
```
### Please click GoDocs chevron above to view current GoDoc information for this package
{{template "contributions"}}
{{template "donations"}}
{{end}}

View File

@@ -0,0 +1,23 @@
{{define "tools documentation" -}}
{{template "header" .}}
## Documentation Management Tool
### Current Features
+ Retrieves contribution activity via github API
+ Regenerates and updates documentation across the entire code base for each individual package
+ Allows for a documentation standard across this codebase
#### How to example
+ This will update the entire codebase when a change is made in the documentation templates
```sh
cd $GOPATH/src/github.com/thrasher-/gocryptotrader/tools/documentation/
go run gocryptotrader.go -r
```
### Please click GoDocs chevron above to view current GoDoc information for this package
{{template "contributions"}}
{{template "donations"}}
{{end}}

View File

@@ -0,0 +1,23 @@
{{define "tools exchange" -}}
{{template "header" .}}
## Exchange Template Management Tool
### Current Features
+ Generates a basic template for incorporating a new exchange in the codebase
#### How to example
+ This will update the entire codebase when a change is made in the documentation templates
+ add -name flag to generate an exchange e.g -name yobit
+ add supporting request protocols by adding either -rest, -ws and or -fix
```sh
cd $GOPATH/src/github.com/thrasher-/gocryptotrader/tools/exchange_template/
go run exchange_template.go -name Bitmex -ws -rest
```
### Please click GoDocs chevron above to view current GoDoc information for this package
{{template "contributions"}}
{{template "donations"}}
{{end}}

View File

@@ -0,0 +1,20 @@
{{define "tools huobiauth" -}}
{{template "header" .}}
## Huobi Authentication Management Tool
### Current Features
+ Generates a public and private key from a private key provided by Huobi for
API Authentication.
+ Move your file into the same folder as the Huobi auth tool
Generate Keys:
```bash
cd $GOPATH/src/github.com/thrasher-/gocryptotrader/tools/huobi_auth/
go run main.go
```
### Please click GoDocs chevron above to view current GoDoc information for this package
{{template "contributions"}}
{{template "donations"}}
{{end}}

View File

@@ -0,0 +1,18 @@
{{define "tools portfolio" -}}
{{template "header" .}}
## Portfolio Retrievement Tool
### Current Features
+ Fetches portfolio details
Example:
```bash
cd $GOPATH/src/github.com/thrasher-/gocryptotrader/tools/portfolio/
go run portfolio.go -infile path/to/config.json -key AESDecryptionKey
```
### Please click GoDocs chevron above to view current GoDoc information for this package
{{template "contributions"}}
{{template "donations"}}
{{end}}

View File

@@ -0,0 +1,16 @@
{{define "tools" -}}
{{template "header" .}}
## Current Features
This folder contains an assortment of tools.
+ Configuration
+ Documentation creation
+ Portfolio monitoring
+ Exchange deployment
+ Websocket client
Please see individual tool's README file
{{template "contributions"}}
{{template "donations"}}
{{end}}

View File

@@ -0,0 +1,18 @@
{{define "tools websocket" -}}
{{template "header" .}}
## Websocket Client Tool
### Current Features
+ Starts a websocket client
Example:
```bash
cd $GOPATH/src/github.com/thrasher-/gocryptotrader/tools/websocket_client/
go run main.go
```
### Please click GoDocs chevron above to view current GoDoc information for this package
{{template "contributions"}}
{{template "donations"}}
{{end}}