diff --git a/README.md b/README.md index 6d56dfe2..0c16eba5 100644 --- a/README.md +++ b/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 | diff --git a/common/README.md b/common/README.md index 26191847..18139386 100644 --- a/common/README.md +++ b/common/README.md @@ -10,7 +10,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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 diff --git a/config/README.md b/config/README.md index a03e34b5..98095f44 100644 --- a/config/README.md +++ b/config/README.md @@ -10,7 +10,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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 diff --git a/currency/README.md b/currency/README.md index 18be21e3..4a992014 100644 --- a/currency/README.md +++ b/currency/README.md @@ -10,7 +10,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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 diff --git a/currency/pair/README.md b/currency/pair/README.md index 0e620800..fac1f4aa 100644 --- a/currency/pair/README.md +++ b/currency/pair/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/currency pair) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/currency/pair) [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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 diff --git a/currency/symbol/README.md b/currency/symbol/README.md index 37807fe3..9c4caeec 100644 --- a/currency/symbol/README.md +++ b/currency/symbol/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/currency symbol) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/currency/symbol) [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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 diff --git a/currency/translation/README.md b/currency/translation/README.md index e1499fd9..47e35fe6 100644 --- a/currency/translation/README.md +++ b/currency/translation/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/currency translation) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/currency/translation) [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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 diff --git a/doc/coding_style.md b/doc/coding_style.md index 33a8d374..ec7e1956 100644 --- a/doc/coding_style.md +++ b/doc/coding_style.md @@ -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 } diff --git a/events/README.md b/events/README.md index 3ce3298c..73250d71 100644 --- a/events/README.md +++ b/events/README.md @@ -10,7 +10,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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 diff --git a/exchanges/README.md b/exchanges/README.md index 1f2377b6..f7cac594 100644 --- a/exchanges/README.md +++ b/exchanges/README.md @@ -10,7 +10,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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 diff --git a/exchanges/nonce/README.md b/exchanges/nonce/README.md index c53e9666..c6ee0b60 100644 --- a/exchanges/nonce/README.md +++ b/exchanges/nonce/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges nonce) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges/nonce) [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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 diff --git a/exchanges/orderbook/README.md b/exchanges/orderbook/README.md index 565b6ab9..a3b20890 100644 --- a/exchanges/orderbook/README.md +++ b/exchanges/orderbook/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges orderbook) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges/orderbook) [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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 diff --git a/exchanges/stats/README.md b/exchanges/stats/README.md index 3c332aea..647c7359 100644 --- a/exchanges/stats/README.md +++ b/exchanges/stats/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges stats) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges/stats) [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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 diff --git a/exchanges/ticker/README.md b/exchanges/ticker/README.md index eacba5f2..ec93b172 100644 --- a/exchanges/ticker/README.md +++ b/exchanges/ticker/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges ticker) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges/ticker) [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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 diff --git a/portfolio/README.md b/portfolio/README.md index e1edbbac..cf6ecf37 100644 --- a/portfolio/README.md +++ b/portfolio/README.md @@ -10,7 +10,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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 diff --git a/smsglobal/README.md b/smsglobal/README.md index 17ce3d08..9c0c6970 100644 --- a/smsglobal/README.md +++ b/smsglobal/README.md @@ -10,7 +10,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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 diff --git a/testdata/README.md b/testdata/README.md index 85f332e0..d1b4f70f 100644 --- a/testdata/README.md +++ b/testdata/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/testdata) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/ [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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 diff --git a/tools/README.md b/tools/README.md index 77376b86..df1a0ab3 100644 --- a/tools/README.md +++ b/tools/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/tools) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/ [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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 diff --git a/tools/documentation/documentation.go b/tools/documentation/documentation.go index 6c56621e..449af062 100644 --- a/tools/documentation/documentation.go +++ b/tools/documentation/documentation.go @@ -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)) diff --git a/tools/documentation/readme_templates/common_readme.tmpl b/tools/documentation/readme_templates/common_readme.tmpl index ace0be94..44888af0 100644 --- a/tools/documentation/readme_templates/common_readme.tmpl +++ b/tools/documentation/readme_templates/common_readme.tmpl @@ -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"}} diff --git a/tools/documentation/readme_templates/config_readme.tmpl b/tools/documentation/readme_templates/config_readme.tmpl index 1e74ce84..2510020f 100644 --- a/tools/documentation/readme_templates/config_readme.tmpl +++ b/tools/documentation/readme_templates/config_readme.tmpl @@ -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"}} diff --git a/tools/documentation/readme_templates/currency_pair_readme.tmpl b/tools/documentation/readme_templates/currency_pair_readme.tmpl index 92b9ff2f..042285ab 100644 --- a/tools/documentation/readme_templates/currency_pair_readme.tmpl +++ b/tools/documentation/readme_templates/currency_pair_readme.tmpl @@ -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"}} diff --git a/tools/documentation/readme_templates/currency_readme.tmpl b/tools/documentation/readme_templates/currency_readme.tmpl index fb1b1242..7cdf48ed 100644 --- a/tools/documentation/readme_templates/currency_readme.tmpl +++ b/tools/documentation/readme_templates/currency_readme.tmpl @@ -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"}} diff --git a/tools/documentation/readme_templates/currency_symbol_readme.tmpl b/tools/documentation/readme_templates/currency_symbol_readme.tmpl index d020ac0b..424ad811 100644 --- a/tools/documentation/readme_templates/currency_symbol_readme.tmpl +++ b/tools/documentation/readme_templates/currency_symbol_readme.tmpl @@ -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"}} diff --git a/tools/documentation/readme_templates/currency_translation_readme.tmpl b/tools/documentation/readme_templates/currency_translation_readme.tmpl index e127a46e..b383128a 100644 --- a/tools/documentation/readme_templates/currency_translation_readme.tmpl +++ b/tools/documentation/readme_templates/currency_translation_readme.tmpl @@ -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"}} diff --git a/tools/documentation/readme_templates/events_readme.tmpl b/tools/documentation/readme_templates/events_readme.tmpl index d61fa9e6..b9a9367c 100644 --- a/tools/documentation/readme_templates/events_readme.tmpl +++ b/tools/documentation/readme_templates/events_readme.tmpl @@ -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"}} diff --git a/tools/documentation/readme_templates/exchanges_nonce_readme.tmpl b/tools/documentation/readme_templates/exchanges_nonce_readme.tmpl index e5ce2962..b969c4ab 100644 --- a/tools/documentation/readme_templates/exchanges_nonce_readme.tmpl +++ b/tools/documentation/readme_templates/exchanges_nonce_readme.tmpl @@ -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"}} diff --git a/tools/documentation/readme_templates/exchanges_orderbook_readme.tmpl b/tools/documentation/readme_templates/exchanges_orderbook_readme.tmpl index 9afb871d..ccb4d40b 100644 --- a/tools/documentation/readme_templates/exchanges_orderbook_readme.tmpl +++ b/tools/documentation/readme_templates/exchanges_orderbook_readme.tmpl @@ -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"}} diff --git a/tools/documentation/readme_templates/exchanges_readme.tmpl b/tools/documentation/readme_templates/exchanges_readme.tmpl index 0f8b6b35..f4f9cf77 100644 --- a/tools/documentation/readme_templates/exchanges_readme.tmpl +++ b/tools/documentation/readme_templates/exchanges_readme.tmpl @@ -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"}} diff --git a/tools/documentation/readme_templates/exchanges_stats_readme.tmpl b/tools/documentation/readme_templates/exchanges_stats_readme.tmpl index dacf0cba..f0bdc956 100644 --- a/tools/documentation/readme_templates/exchanges_stats_readme.tmpl +++ b/tools/documentation/readme_templates/exchanges_stats_readme.tmpl @@ -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"}} diff --git a/tools/documentation/readme_templates/exchanges_ticker_readme.tmpl b/tools/documentation/readme_templates/exchanges_ticker_readme.tmpl index 35f3d031..c848e11f 100644 --- a/tools/documentation/readme_templates/exchanges_ticker_readme.tmpl +++ b/tools/documentation/readme_templates/exchanges_ticker_readme.tmpl @@ -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"}} diff --git a/tools/documentation/readme_templates/portfolio_readme.tmpl b/tools/documentation/readme_templates/portfolio_readme.tmpl index 68ced887..03dec8c0 100644 --- a/tools/documentation/readme_templates/portfolio_readme.tmpl +++ b/tools/documentation/readme_templates/portfolio_readme.tmpl @@ -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"}} diff --git a/tools/documentation/readme_templates/root_readme.tmpl b/tools/documentation/readme_templates/root_readme.tmpl index d12ca03c..ff7ef845 100644 --- a/tools/documentation/readme_templates/root_readme.tmpl +++ b/tools/documentation/readme_templates/root_readme.tmpl @@ -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 diff --git a/tools/documentation/readme_templates/smsglobal_readme.tmpl b/tools/documentation/readme_templates/smsglobal_readme.tmpl index 98d025c7..7b651e3a 100644 --- a/tools/documentation/readme_templates/smsglobal_readme.tmpl +++ b/tools/documentation/readme_templates/smsglobal_readme.tmpl @@ -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"}} diff --git a/tools/documentation/readme_templates/testdata_readme.tmpl b/tools/documentation/readme_templates/testdata_readme.tmpl index 30b42453..15a6e5d9 100644 --- a/tools/documentation/readme_templates/testdata_readme.tmpl +++ b/tools/documentation/readme_templates/testdata_readme.tmpl @@ -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. diff --git a/tools/documentation/readme_templates/tools_readme.tmpl b/tools/documentation/readme_templates/tools_readme.tmpl index f447eaff..6789effa 100644 --- a/tools/documentation/readme_templates/tools_readme.tmpl +++ b/tools/documentation/readme_templates/tools_readme.tmpl @@ -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"}} diff --git a/tools/documentation/readme_templates/web_readme.tmpl b/tools/documentation/readme_templates/web_readme.tmpl index be927649..9d6a5b52 100644 --- a/tools/documentation/readme_templates/web_readme.tmpl +++ b/tools/documentation/readme_templates/web_readme.tmpl @@ -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 diff --git a/tools/documentation/sub_templates/header.tmpl b/tools/documentation/sub_templates/header.tmpl index 5e2ea1a3..b6144bd8 100644 --- a/tools/documentation/sub_templates/header.tmpl +++ b/tools/documentation/sub_templates/header.tmpl @@ -1,11 +1,11 @@ {{define "header" -}} -# GoCryptoTrader package {{.}} +# GoCryptoTrader package {{.Name}} -{{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 diff --git a/tools/documentation/sub_templates/status.tmpl b/tools/documentation/sub_templates/status.tmpl index 71de2a84..82efe96e 100644 --- a/tools/documentation/sub_templates/status.tmpl +++ b/tools/documentation/sub_templates/status.tmpl @@ -1,7 +1,7 @@ {{define "status"}} [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/{{.}}) +{{with .}}[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/{{.}}){{else}}[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/){{end}} [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) {{end}} diff --git a/web/README.md b/web/README.md index 61d01df4..9991ecda 100644 --- a/web/README.md +++ b/web/README.md @@ -10,7 +10,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](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