mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-13 15:09:42 +00:00
Applied fix to documentation.go for contribution HTML_URL.
Added period to documentation templates sentences. Added logic to documentation.go to fix broken links for godoc in sub-packages. Fix coding style to conform to golang idiomatic practice. Applied fix to access main godocs in tools and test data. Generated new documents using tools.
This commit is contained in:
Ryan O'Hara-Reid
38
README.md
38
README.md
@@ -140,25 +140,25 @@ Binaries will be published once the codebase reaches a stable condition.
|
||||
|
||||
|User|Github|Contribution Amount|
|
||||
|--|--|--|
|
||||
| thrasher- | https://api.github.com/users/thrasher- | 411 |
|
||||
| gloriousCode | https://api.github.com/users/gloriousCode | 113 |
|
||||
| shazbert | https://api.github.com/users/shazbert | 108 |
|
||||
| 140am | https://api.github.com/users/140am | 8 |
|
||||
| faddat | https://api.github.com/users/faddat | 4 |
|
||||
| crackcomm | https://api.github.com/users/crackcomm | 3 |
|
||||
| bretep | https://api.github.com/users/bretep | 2 |
|
||||
| gam-phon | https://api.github.com/users/gam-phon | 2 |
|
||||
| cornelk | https://api.github.com/users/cornelk | 2 |
|
||||
| if1live | https://api.github.com/users/if1live | 2 |
|
||||
| daniel-cohen | https://api.github.com/users/daniel-cohen | 1 |
|
||||
| starit | https://api.github.com/users/starit | 1 |
|
||||
| mattkanwisher | https://api.github.com/users/mattkanwisher | 1 |
|
||||
| mKurrels | https://api.github.com/users/mKurrels | 1 |
|
||||
| m1kola | https://api.github.com/users/m1kola | 1 |
|
||||
| tongxiaofeng | https://api.github.com/users/tongxiaofeng | 1 |
|
||||
| idealhack | https://api.github.com/users/idealhack | 1 |
|
||||
| askew- | https://api.github.com/users/askew- | 1 |
|
||||
| snipesjr | https://api.github.com/users/snipesjr | 1 |
|
||||
| thrasher- | https://github.com/thrasher- | 413 |
|
||||
| gloriousCode | https://github.com/gloriousCode | 113 |
|
||||
| shazbert | https://github.com/shazbert | 108 |
|
||||
| 140am | https://github.com/140am | 8 |
|
||||
| faddat | https://github.com/faddat | 4 |
|
||||
| crackcomm | https://github.com/crackcomm | 3 |
|
||||
| bretep | https://github.com/bretep | 2 |
|
||||
| gam-phon | https://github.com/gam-phon | 2 |
|
||||
| cornelk | https://github.com/cornelk | 2 |
|
||||
| if1live | https://github.com/if1live | 2 |
|
||||
| daniel-cohen | https://github.com/daniel-cohen | 1 |
|
||||
| starit | https://github.com/starit | 1 |
|
||||
| mattkanwisher | https://github.com/mattkanwisher | 1 |
|
||||
| mKurrels | https://github.com/mKurrels | 1 |
|
||||
| m1kola | https://github.com/m1kola | 1 |
|
||||
| tongxiaofeng | https://github.com/tongxiaofeng | 1 |
|
||||
| idealhack | https://github.com/idealhack | 1 |
|
||||
| askew- | https://github.com/askew- | 1 |
|
||||
| snipesjr | https://github.com/snipesjr | 1 |
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This common package is part of the GoCryptoTrader codebase
|
||||
This common package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
@@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
|
||||
## Current Features for common
|
||||
|
||||
+ This package collates basic broad functions that are used throughout this codebase
|
||||
+ This package collates basic broad functions that are used throughout this codebase.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This config package is part of the GoCryptoTrader codebase
|
||||
This config package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
@@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
|
||||
## Current Features for config
|
||||
|
||||
+ This package deals with configuration utilities
|
||||
+ This package deals with configuration utilities.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This currency package is part of the GoCryptoTrader codebase
|
||||
This currency package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
@@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
|
||||
## Current Features for currency
|
||||
|
||||
+ Currency package deals with currency pair generation, manipulation and tracking
|
||||
+ Currency package deals with currency pair generation, manipulation and tracking.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
|
||||
|
||||
@@ -5,12 +5,12 @@
|
||||
|
||||
[](https://travis-ci.org/thrasher-/gocryptotrader)
|
||||
[](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/currency pair)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/currency/pair)
|
||||
[](http://codecov.io/github/thrasher-/gocryptotrader?branch=master)
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This currency pair package is part of the GoCryptoTrader codebase
|
||||
This currency pair package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
@@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
|
||||
## Current Features for currency pair
|
||||
|
||||
+ This package services the currency package
|
||||
+ This package services the currency package.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
|
||||
|
||||
@@ -5,12 +5,12 @@
|
||||
|
||||
[](https://travis-ci.org/thrasher-/gocryptotrader)
|
||||
[](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/currency symbol)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/currency/symbol)
|
||||
[](http://codecov.io/github/thrasher-/gocryptotrader?branch=master)
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This currency symbol package is part of the GoCryptoTrader codebase
|
||||
This currency symbol package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
@@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
|
||||
## Current Features for currency symbol
|
||||
|
||||
+ This package services the currency package
|
||||
+ This package services the currency package.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
|
||||
|
||||
@@ -5,12 +5,12 @@
|
||||
|
||||
[](https://travis-ci.org/thrasher-/gocryptotrader)
|
||||
[](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/currency translation)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/currency/translation)
|
||||
[](http://codecov.io/github/thrasher-/gocryptotrader?branch=master)
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This currency translation package is part of the GoCryptoTrader codebase
|
||||
This currency translation package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
@@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
|
||||
## Current Features for currency translation
|
||||
|
||||
+ This package services the currency package with translation functions
|
||||
+ This package services the currency package with translation functions.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
|
||||
|
||||
@@ -20,7 +20,6 @@ func SendHTTPRequest(method, path string, headers map[string]string, body io.Rea
|
||||
}
|
||||
|
||||
req, err := http.NewRequest(method, path, body)
|
||||
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This events package is part of the GoCryptoTrader codebase
|
||||
This events package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
@@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
|
||||
## Current Features for events
|
||||
|
||||
+ The events package handles events from GoCryptoTrader bot
|
||||
+ The events package handles events from GoCryptoTrader bot.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This exchanges package is part of the GoCryptoTrader codebase
|
||||
This exchanges package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
@@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
|
||||
## Current Features for exchanges
|
||||
|
||||
+ This package is used to connect and query data from supported exchanges
|
||||
+ This package is used to connect and query data from supported exchanges.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
|
||||
|
||||
@@ -5,12 +5,12 @@
|
||||
|
||||
[](https://travis-ci.org/thrasher-/gocryptotrader)
|
||||
[](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges nonce)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges/nonce)
|
||||
[](http://codecov.io/github/thrasher-/gocryptotrader?branch=master)
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This exchanges nonce package is part of the GoCryptoTrader codebase
|
||||
This exchanges nonce package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
@@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
|
||||
## Current Features for exchanges nonce
|
||||
|
||||
+ This package services the exchanges package with nonce creation
|
||||
+ This package services the exchanges package with nonce creation.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
|
||||
|
||||
@@ -5,12 +5,12 @@
|
||||
|
||||
[](https://travis-ci.org/thrasher-/gocryptotrader)
|
||||
[](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges orderbook)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges/orderbook)
|
||||
[](http://codecov.io/github/thrasher-/gocryptotrader?branch=master)
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This exchanges orderbook package is part of the GoCryptoTrader codebase
|
||||
This exchanges orderbook package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
@@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
|
||||
## Current Features for exchanges orderbook
|
||||
|
||||
+ This package facilitates orderbook generation
|
||||
+ This package facilitates orderbook generation.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
|
||||
|
||||
@@ -5,12 +5,12 @@
|
||||
|
||||
[](https://travis-ci.org/thrasher-/gocryptotrader)
|
||||
[](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges stats)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges/stats)
|
||||
[](http://codecov.io/github/thrasher-/gocryptotrader?branch=master)
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This exchanges stats package is part of the GoCryptoTrader codebase
|
||||
This exchanges stats package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
@@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
|
||||
## Current Features for exchanges stats
|
||||
|
||||
+ This package services the exchanges package
|
||||
+ This package services the exchanges package.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
|
||||
|
||||
@@ -5,12 +5,12 @@
|
||||
|
||||
[](https://travis-ci.org/thrasher-/gocryptotrader)
|
||||
[](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges ticker)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges/ticker)
|
||||
[](http://codecov.io/github/thrasher-/gocryptotrader?branch=master)
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This exchanges ticker package is part of the GoCryptoTrader codebase
|
||||
This exchanges ticker package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
@@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
|
||||
## Current Features for exchanges ticker
|
||||
|
||||
+ This services the exchanges package by ticker functions
|
||||
+ This services the exchanges package by ticker functions.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This portfolio package is part of the GoCryptoTrader codebase
|
||||
This portfolio package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
@@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
|
||||
## Current Features for portfolio
|
||||
|
||||
+ This package allows for the monitoring of portfolio data
|
||||
+ This package allows for the monitoring of portfolio data.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This smsglobal package is part of the GoCryptoTrader codebase
|
||||
This smsglobal package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
@@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
|
||||
## Current Features for smsglobal
|
||||
|
||||
+ This package allows for the messaging of events to a personal phone number or a group of phone numbers
|
||||
+ This package allows for the messaging of events to a personal phone number or a group of phone numbers.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
|
||||
|
||||
4
testdata/README.md
vendored
4
testdata/README.md
vendored
@@ -5,12 +5,12 @@
|
||||
|
||||
[](https://travis-ci.org/thrasher-/gocryptotrader)
|
||||
[](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/testdata)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/
|
||||
[](http://codecov.io/github/thrasher-/gocryptotrader?branch=master)
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This testdata package is part of the GoCryptoTrader codebase
|
||||
This testdata package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
|
||||
@@ -5,12 +5,12 @@
|
||||
|
||||
[](https://travis-ci.org/thrasher-/gocryptotrader)
|
||||
[](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/tools)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/
|
||||
[](http://codecov.io/github/thrasher-/gocryptotrader?branch=master)
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This tools package is part of the GoCryptoTrader codebase
|
||||
This tools package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
@@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
|
||||
## Current Features
|
||||
|
||||
This folder contains an assortment of tools
|
||||
This folder contains an assortment of tools.
|
||||
|
||||
+ Configuration
|
||||
+ Documentation creation
|
||||
@@ -29,10 +29,16 @@ This folder contains an assortment of tools
|
||||
+ Websocket client
|
||||
|
||||
|
||||
Example Run for documentation generation - flags -v Verbose & -R Replace files
|
||||
```
|
||||
Example Run for documentation generation - flags -v Verbose & -r Replace files
|
||||
```sh
|
||||
cd documentation/
|
||||
go run documentation -v
|
||||
go run documentation.go -v
|
||||
```
|
||||
OR for full replacement.
|
||||
|
||||
```sh
|
||||
cd documentation/
|
||||
go run documentation.go -v -r
|
||||
```
|
||||
|
||||
## Contribution
|
||||
|
||||
@@ -6,6 +6,7 @@ import (
|
||||
"html/template"
|
||||
"log"
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
"github.com/thrasher-/gocryptotrader/common"
|
||||
)
|
||||
@@ -46,11 +47,12 @@ var (
|
||||
type readme struct {
|
||||
Name string
|
||||
Contributors []contributor
|
||||
NameURL string
|
||||
}
|
||||
|
||||
type contributor struct {
|
||||
Login string `json:"login"`
|
||||
URL string `json:"url"`
|
||||
URL string `json:"html_url"`
|
||||
Contributions int `json:"contributions"`
|
||||
}
|
||||
|
||||
@@ -153,10 +155,23 @@ func addReadmeData(packageName string) {
|
||||
readmeInfo := readme{
|
||||
Name: packageName,
|
||||
Contributors: contributors,
|
||||
NameURL: getslashFromName(packageName),
|
||||
}
|
||||
codebaseReadme[packageName] = readmeInfo
|
||||
}
|
||||
|
||||
// returns a string for godoc package names
|
||||
func getslashFromName(packageName string) string {
|
||||
if strings.Contains(packageName, " ") {
|
||||
s := strings.Split(packageName, " ")
|
||||
return strings.Join(s, "/")
|
||||
}
|
||||
if packageName == "testdata" || packageName == "tools" {
|
||||
return ""
|
||||
}
|
||||
return packageName
|
||||
}
|
||||
|
||||
// adds all the template files
|
||||
func addTemplates() error {
|
||||
glob, err := template.ParseGlob(fmt.Sprintf("readme_templates%s*", path))
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{{define "common" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features for {{.Name}}
|
||||
|
||||
+ This package collates basic broad functions that are used throughout this codebase
|
||||
+ This package collates basic broad functions that are used throughout this codebase.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{{define "config" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features for {{.Name}}
|
||||
|
||||
+ This package deals with configuration utilities
|
||||
+ This package deals with configuration utilities.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{{define "currency pair" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features for {{.Name}}
|
||||
|
||||
+ This package services the currency package
|
||||
+ This package services the currency package.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{{define "currency" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features for {{.Name}}
|
||||
|
||||
+ Currency package deals with currency pair generation, manipulation and tracking
|
||||
+ Currency package deals with currency pair generation, manipulation and tracking.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{{define "currency symbol" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features for {{.Name}}
|
||||
|
||||
+ This package services the currency package
|
||||
+ This package services the currency package.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{{define "currency translation" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features for {{.Name}}
|
||||
|
||||
+ This package services the currency package with translation functions
|
||||
+ This package services the currency package with translation functions.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{{define "events" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features for {{.Name}}
|
||||
|
||||
+ The events package handles events from GoCryptoTrader bot
|
||||
+ The events package handles events from GoCryptoTrader bot.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{{define "exchanges nonce" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features for {{.Name}}
|
||||
|
||||
+ This package services the exchanges package with nonce creation
|
||||
+ This package services the exchanges package with nonce creation.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{{define "exchanges orderbook" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features for {{.Name}}
|
||||
|
||||
+ This package facilitates orderbook generation
|
||||
+ This package facilitates orderbook generation.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{{define "exchanges" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features for {{.Name}}
|
||||
|
||||
+ This package is used to connect and query data from supported exchanges
|
||||
+ This package is used to connect and query data from supported exchanges.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{{define "exchanges stats" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features for {{.Name}}
|
||||
|
||||
+ This package services the exchanges package
|
||||
+ This package services the exchanges package.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{{define "exchanges ticker" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features for {{.Name}}
|
||||
|
||||
+ This services the exchanges package by ticker functions
|
||||
+ This services the exchanges package by ticker functions.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{{define "portfolio" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features for {{.Name}}
|
||||
|
||||
+ This package allows for the monitoring of portfolio data
|
||||
+ This package allows for the monitoring of portfolio data.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
|
||||
@@ -87,6 +87,24 @@ platform.
|
||||
|
||||
### Linux/OSX
|
||||
|
||||
We use the `dep` tool provided by Golang for managing dependencies. As it is not officially part
|
||||
of the go tools package suite, you will need to manually install it if you have not already.
|
||||
|
||||
On MacOS you can install or upgrade to the latest released version with Homebrew:
|
||||
|
||||
```sh
|
||||
brew install dep
|
||||
brew upgrade dep
|
||||
```
|
||||
|
||||
On linux or MacOS, you can also install it via `go get`:
|
||||
|
||||
```sh
|
||||
go get -u github.com/golang/dep/cmd/dep
|
||||
```
|
||||
|
||||
After `dep` is installed, please follow the instructions below:
|
||||
|
||||
```bash
|
||||
go get github.com/thrasher-/gocryptotrader
|
||||
cd $GOPATH/src/github.com/thrasher-/gocryptotrader
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{{define "smsglobal" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features for {{.Name}}
|
||||
|
||||
+ This package allows for the messaging of events to a personal phone number or a group of phone numbers
|
||||
+ This package allows for the messaging of events to a personal phone number or a group of phone numbers.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{{define "testdata" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features
|
||||
|
||||
This folder contains a configuration test file for non-deployement test params.
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{{define "tools" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features
|
||||
|
||||
This folder contains an assortment of tools
|
||||
This folder contains an assortment of tools.
|
||||
|
||||
+ Configuration
|
||||
+ Documentation creation
|
||||
@@ -11,10 +11,16 @@ This folder contains an assortment of tools
|
||||
+ Websocket client
|
||||
|
||||
|
||||
Example Run for documentation generation - flags -v Verbose & -R Replace files
|
||||
```
|
||||
Example Run for documentation generation - flags -v Verbose & -r Replace files
|
||||
```sh
|
||||
cd documentation/
|
||||
go run documentation -v
|
||||
go run documentation.go -v
|
||||
```
|
||||
OR for full replacement.
|
||||
|
||||
```sh
|
||||
cd documentation/
|
||||
go run documentation.go -v -r
|
||||
```
|
||||
{{template "contributions"}}
|
||||
{{template "donations"}}
|
||||
|
||||
@@ -1,8 +1,7 @@
|
||||
{{define "web" -}}
|
||||
{{template "header" .Name}}
|
||||
{{template "header" .}}
|
||||
## Current Features
|
||||
|
||||
|
||||
+ It can run
|
||||
+ It can be compiled with Electron to run as an executable
|
||||
+ Websocket support to listen to GoCryptoTrader events
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
{{define "header" -}}
|
||||
# GoCryptoTrader package {{.}}
|
||||
# GoCryptoTrader package {{.Name}}
|
||||
|
||||
<img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70">
|
||||
|
||||
{{template "status" .}}
|
||||
{{template "status" .NameURL}}
|
||||
|
||||
This {{.}} package is part of the GoCryptoTrader codebase
|
||||
This {{.Name}} package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{{define "status"}}
|
||||
[](https://travis-ci.org/thrasher-/gocryptotrader)
|
||||
[](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE)
|
||||
[](https://godoc.org/github.com/thrasher-/gocryptotrader/{{.}})
|
||||
{{with .}}[](https://godoc.org/github.com/thrasher-/gocryptotrader/{{.}}){{else}}[](https://godoc.org/github.com/thrasher-/gocryptotrader/){{end}}
|
||||
[](http://codecov.io/github/thrasher-/gocryptotrader?branch=master)
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
{{end}}
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
||||
|
||||
|
||||
This web package is part of the GoCryptoTrader codebase
|
||||
This web package is part of the GoCryptoTrader codebase.
|
||||
|
||||
## This is still in active development
|
||||
|
||||
@@ -20,7 +20,6 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
|
||||
## Current Features
|
||||
|
||||
|
||||
+ It can run
|
||||
+ It can be compiled with Electron to run as an executable
|
||||
+ Websocket support to listen to GoCryptoTrader events
|
||||
|
||||
Reference in New Issue
Block a user