diff --git a/CONTRIBUTORS b/CONTRIBUTORS index f1606184..77015702 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -1,21 +1,23 @@ -Thanks to the following contributors: -Scott - gloriousCode -Ryan O'Hara-Reid - shazbert -Jacob Gadikian - faddat -Cornel - cornelk -Łukasz Kurowski - crackcomm -Adrian Gallagher - thrasher- -Manuel Kreutz - 140am -libsora.so - if1live -Tong - tongxiaofeng -Jamie Cheng - starit -Jake - snipesjr -Bret Palsson - bretep -Yaser Alraddadi - gam-phon -Tong - tongxiaofeng -Matthew Campbell - mattkanwisher -Yang Li - idealhack -Mikalai Radchuk - m1kola -Michael Kurrels - mKurrels -Artem Dubinin - askew- \ No newline at end of file +Thanks to the following contributors: +thrasher- | https://github.com/thrasher- +shazbert | https://github.com/shazbert +gloriousCode | https://github.com/gloriousCode +140am | https://github.com/140am +faddat | https://github.com/faddat +crackcomm | https://github.com/crackcomm +bretep | https://github.com/bretep +gam-phon | https://github.com/gam-phon +cornelk | https://github.com/cornelk +if1live | https://github.com/if1live +daniel-cohen | https://github.com/daniel-cohen +starit | https://github.com/starit +Jimexist | https://github.com/Jimexist +mattkanwisher | https://github.com/mattkanwisher +mKurrels | https://github.com/mKurrels +m1kola | https://github.com/m1kola +tongxiaofeng | https://github.com/tongxiaofeng +idealhack | https://github.com/idealhack +askew- | https://github.com/askew- +snipesjr | https://github.com/snipesjr + diff --git a/LICENSE b/LICENSE index 846a4784..f8b345f9 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2014-2017 The GoCryptoTrader Developers +Copyright (c) 2014-2018 The GoCryptoTrader Developers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - diff --git a/README.md b/README.md index 0c16eba5..b57528ab 100644 --- a/README.md +++ b/README.md @@ -138,11 +138,13 @@ Binaries will be published once the codebase reaches a stable condition. ## Contributor List +### A very special thank you to all who have contributed to this program: + |User|Github|Contribution Amount| |--|--|--| -| thrasher- | https://github.com/thrasher- | 413 | +| thrasher- | https://github.com/thrasher- | 417 | +| shazbert | https://github.com/shazbert | 125 | | 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 | @@ -152,6 +154,7 @@ Binaries will be published once the codebase reaches a stable condition. | if1live | https://github.com/if1live | 2 | | daniel-cohen | https://github.com/daniel-cohen | 1 | | starit | https://github.com/starit | 1 | +| Jimexist | https://github.com/Jimexist | 1 | | mattkanwisher | https://github.com/mattkanwisher | 1 | | mKurrels | https://github.com/mKurrels | 1 | | m1kola | https://github.com/m1kola | 1 | diff --git a/common/README.md b/common/README.md index 18139386..4e6be715 100644 --- a/common/README.md +++ b/common/README.md @@ -1,4 +1,4 @@ -# GoCryptoTrader package common +# GoCryptoTrader package Common diff --git a/config/README.md b/config/README.md index 98095f44..4611cab8 100644 --- a/config/README.md +++ b/config/README.md @@ -1,4 +1,4 @@ -# GoCryptoTrader package config +# GoCryptoTrader package Config diff --git a/currency/README.md b/currency/README.md index 4a992014..d37519fd 100644 --- a/currency/README.md +++ b/currency/README.md @@ -1,4 +1,4 @@ -# GoCryptoTrader package currency +# GoCryptoTrader package Currency diff --git a/currency/pair/README.md b/currency/pair/README.md index fac1f4aa..9e30288c 100644 --- a/currency/pair/README.md +++ b/currency/pair/README.md @@ -1,4 +1,4 @@ -# GoCryptoTrader package currency pair +# GoCryptoTrader package Pair @@ -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 pair package is part of the GoCryptoTrader codebase. +This pair package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -18,7 +18,7 @@ You can track ideas, planned features and what's in progresss on this Trello boa Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) -## Current Features for currency pair +## Current Features for pair + This package services the currency package. diff --git a/currency/symbol/README.md b/currency/symbol/README.md index 9c4caeec..6e45d494 100644 --- a/currency/symbol/README.md +++ b/currency/symbol/README.md @@ -1,4 +1,4 @@ -# GoCryptoTrader package currency symbol +# GoCryptoTrader package Symbol @@ -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 symbol package is part of the GoCryptoTrader codebase. +This symbol package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -18,7 +18,7 @@ You can track ideas, planned features and what's in progresss on this Trello boa Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) -## Current Features for currency symbol +## Current Features for symbol + This package services the currency package. diff --git a/currency/translation/README.md b/currency/translation/README.md index 47e35fe6..44b47b4e 100644 --- a/currency/translation/README.md +++ b/currency/translation/README.md @@ -1,4 +1,4 @@ -# GoCryptoTrader package currency translation +# GoCryptoTrader package Translation @@ -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 translation package is part of the GoCryptoTrader codebase. +This translation package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -18,7 +18,7 @@ You can track ideas, planned features and what's in progresss on this Trello boa Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) -## Current Features for currency translation +## Current Features for translation + This package services the currency package with translation functions. diff --git a/events/README.md b/events/README.md index 73250d71..9616ad9d 100644 --- a/events/README.md +++ b/events/README.md @@ -1,4 +1,4 @@ -# GoCryptoTrader package events +# GoCryptoTrader package Events diff --git a/exchanges/README.md b/exchanges/README.md index f7cac594..7ae734dd 100644 --- a/exchanges/README.md +++ b/exchanges/README.md @@ -1,4 +1,4 @@ -# GoCryptoTrader package exchanges +# GoCryptoTrader package Exchanges diff --git a/exchanges/alphapoint/README.md b/exchanges/alphapoint/README.md new file mode 100644 index 00000000..f59025e4 --- /dev/null +++ b/exchanges/alphapoint/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Alphapoint + + + + +[![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/alphapoint) +[![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 alphapoint package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Alphapoint Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/anx/README.md b/exchanges/anx/README.md new file mode 100644 index 00000000..e91a86fc --- /dev/null +++ b/exchanges/anx/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Anx + + + + +[![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/anx) +[![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 anx package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## ANX Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/binance/README.md b/exchanges/binance/README.md new file mode 100644 index 00000000..c2482dd0 --- /dev/null +++ b/exchanges/binance/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Binance + + + + +[![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/binance) +[![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 binance package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Binance Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/bitfinex/README.md b/exchanges/bitfinex/README.md new file mode 100644 index 00000000..baad0fed --- /dev/null +++ b/exchanges/bitfinex/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Bitfinex + + + + +[![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/bitfinex) +[![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 bitfinex package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Bitfinex Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/bitflyer/README.md b/exchanges/bitflyer/README.md new file mode 100644 index 00000000..646e8bab --- /dev/null +++ b/exchanges/bitflyer/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Bitflyer + + + + +[![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/bitflyer) +[![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 bitflyer package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Bitflyer Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/bithumb/README.md b/exchanges/bithumb/README.md new file mode 100644 index 00000000..614f5297 --- /dev/null +++ b/exchanges/bithumb/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Bithumb + + + + +[![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/bithumb) +[![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 bithumb package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Bithumb Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/bitstamp/README.md b/exchanges/bitstamp/README.md new file mode 100644 index 00000000..835198d1 --- /dev/null +++ b/exchanges/bitstamp/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Bitstamp + + + + +[![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/bitstamp) +[![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 bitstamp package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Bitstamp Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/bittrex/README.md b/exchanges/bittrex/README.md new file mode 100644 index 00000000..313e87ed --- /dev/null +++ b/exchanges/bittrex/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Bittrex + + + + +[![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/bittrex) +[![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 bittrex package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Bittrex Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/btcc/README.md b/exchanges/btcc/README.md new file mode 100644 index 00000000..9db2246f --- /dev/null +++ b/exchanges/btcc/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Btcc + + + + +[![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/btcc) +[![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 btcc package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## BTCC Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/btcmarkets/README.md b/exchanges/btcmarkets/README.md new file mode 100644 index 00000000..18a716cd --- /dev/null +++ b/exchanges/btcmarkets/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Btcmarkets + + + + +[![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/btcmarkets) +[![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 btcmarkets package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## BTCMarkets Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/coinut/README.md b/exchanges/coinut/README.md new file mode 100644 index 00000000..e8793aa9 --- /dev/null +++ b/exchanges/coinut/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Coinut + + + + +[![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/coinut) +[![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 coinut package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Coinut Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/exmo/README.md b/exchanges/exmo/README.md new file mode 100644 index 00000000..a80783db --- /dev/null +++ b/exchanges/exmo/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Exmo + + + + +[![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/exmo) +[![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 exmo package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Exmo Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/gdax/README.md b/exchanges/gdax/README.md new file mode 100644 index 00000000..e8522da3 --- /dev/null +++ b/exchanges/gdax/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Gdax + + + + +[![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/gdax) +[![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 gdax package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## GDAX Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/gemini/README.md b/exchanges/gemini/README.md new file mode 100644 index 00000000..9dae8e24 --- /dev/null +++ b/exchanges/gemini/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Gemini + + + + +[![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/gemini) +[![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 gemini package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Gemini Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/hitbtc/README.md b/exchanges/hitbtc/README.md new file mode 100644 index 00000000..d94a4148 --- /dev/null +++ b/exchanges/hitbtc/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Hitbtc + + + + +[![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/hitbtc) +[![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 hitbtc package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## HitBTC Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/huobi/README.md b/exchanges/huobi/README.md new file mode 100644 index 00000000..39284cb5 --- /dev/null +++ b/exchanges/huobi/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Huobi + + + + +[![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/huobi) +[![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 huobi package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Huobi Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/itbit/README.md b/exchanges/itbit/README.md new file mode 100644 index 00000000..5b358b9d --- /dev/null +++ b/exchanges/itbit/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Itbit + + + + +[![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/itbit) +[![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 itbit package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Itbit Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/kraken/README.md b/exchanges/kraken/README.md new file mode 100644 index 00000000..99c79a99 --- /dev/null +++ b/exchanges/kraken/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Kraken + + + + +[![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/kraken) +[![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 kraken package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Kraken Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/lakebtc/README.md b/exchanges/lakebtc/README.md new file mode 100644 index 00000000..3f782876 --- /dev/null +++ b/exchanges/lakebtc/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Lakebtc + + + + +[![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/lakebtc) +[![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 lakebtc package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## LakeBTC Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/liqui/README.md b/exchanges/liqui/README.md new file mode 100644 index 00000000..ceb3cd16 --- /dev/null +++ b/exchanges/liqui/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Liqui + + + + +[![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/liqui) +[![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 liqui package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Liqui Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/localbitcoins/README.md b/exchanges/localbitcoins/README.md new file mode 100644 index 00000000..81ac2335 --- /dev/null +++ b/exchanges/localbitcoins/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Localbitcoins + + + + +[![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/localbitcoins) +[![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 localbitcoins package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## LocalBitcoins Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/nonce/README.md b/exchanges/nonce/README.md index c6ee0b60..aa92dc2a 100644 --- a/exchanges/nonce/README.md +++ b/exchanges/nonce/README.md @@ -1,4 +1,4 @@ -# GoCryptoTrader package exchanges nonce +# GoCryptoTrader package Nonce @@ -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 nonce package is part of the GoCryptoTrader codebase. +This nonce package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -18,7 +18,7 @@ You can track ideas, planned features and what's in progresss on this Trello boa Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) -## Current Features for exchanges nonce +## Current Features for nonce + This package services the exchanges package with nonce creation. diff --git a/exchanges/okcoin/README.md b/exchanges/okcoin/README.md new file mode 100644 index 00000000..c0abbc41 --- /dev/null +++ b/exchanges/okcoin/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Okcoin + + + + +[![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/okcoin) +[![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 okcoin package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## OKCoin Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/okex/README.md b/exchanges/okex/README.md new file mode 100644 index 00000000..ddb43470 --- /dev/null +++ b/exchanges/okex/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Okex + + + + +[![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/okex) +[![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 okex package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## OKex Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/orderbook/README.md b/exchanges/orderbook/README.md index a3b20890..db598dfd 100644 --- a/exchanges/orderbook/README.md +++ b/exchanges/orderbook/README.md @@ -1,4 +1,4 @@ -# GoCryptoTrader package exchanges orderbook +# GoCryptoTrader package Orderbook @@ -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 orderbook package is part of the GoCryptoTrader codebase. +This orderbook package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -18,7 +18,7 @@ You can track ideas, planned features and what's in progresss on this Trello boa Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) -## Current Features for exchanges orderbook +## Current Features for orderbook + This package facilitates orderbook generation. diff --git a/exchanges/poloniex/README.md b/exchanges/poloniex/README.md new file mode 100644 index 00000000..15aa5dc0 --- /dev/null +++ b/exchanges/poloniex/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Poloniex + + + + +[![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/poloniex) +[![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 poloniex package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Poloniex Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/stats/README.md b/exchanges/stats/README.md index 647c7359..d5d66ce5 100644 --- a/exchanges/stats/README.md +++ b/exchanges/stats/README.md @@ -1,4 +1,4 @@ -# GoCryptoTrader package exchanges stats +# GoCryptoTrader package Stats @@ -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 stats package is part of the GoCryptoTrader codebase. +This stats package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -18,7 +18,7 @@ You can track ideas, planned features and what's in progresss on this Trello boa Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) -## Current Features for exchanges stats +## Current Features for stats + This package services the exchanges package. diff --git a/exchanges/ticker/README.md b/exchanges/ticker/README.md index ec93b172..883f915f 100644 --- a/exchanges/ticker/README.md +++ b/exchanges/ticker/README.md @@ -1,4 +1,4 @@ -# GoCryptoTrader package exchanges ticker +# GoCryptoTrader package Ticker @@ -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 ticker package is part of the GoCryptoTrader codebase. +This ticker package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -18,7 +18,7 @@ You can track ideas, planned features and what's in progresss on this Trello boa Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) -## Current Features for exchanges ticker +## Current Features for ticker + This services the exchanges package by ticker functions. diff --git a/exchanges/wex/README.md b/exchanges/wex/README.md new file mode 100644 index 00000000..be919621 --- /dev/null +++ b/exchanges/wex/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Wex + + + + +[![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/wex) +[![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 wex package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Wex Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/exchanges/yobit/README.md b/exchanges/yobit/README.md new file mode 100644 index 00000000..cc3c7145 --- /dev/null +++ b/exchanges/yobit/README.md @@ -0,0 +1,47 @@ +# GoCryptoTrader package Yobit + + + + +[![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/yobit) +[![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 yobit package is part of the GoCryptoTrader codebase. + +## This is still in active development + +You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Yobit Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## Contribution + +Please feel free to submit any pull requests or suggest any desired features to be added. + +When submitting a PR, please abide by our coding guidelines: + ++ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). ++ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. ++ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). ++ Pull requests need to be based on and opened against the `master` branch. + +## Donations + + + +If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: + +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** + diff --git a/portfolio/README.md b/portfolio/README.md index cf6ecf37..3ab7662a 100644 --- a/portfolio/README.md +++ b/portfolio/README.md @@ -1,4 +1,4 @@ -# GoCryptoTrader package portfolio +# GoCryptoTrader package Portfolio diff --git a/smsglobal/README.md b/smsglobal/README.md index 9c0c6970..294655af 100644 --- a/smsglobal/README.md +++ b/smsglobal/README.md @@ -1,4 +1,4 @@ -# GoCryptoTrader package smsglobal +# GoCryptoTrader package Smsglobal diff --git a/testdata/README.md b/testdata/README.md index d1b4f70f..b976c9b1 100644 --- a/testdata/README.md +++ b/testdata/README.md @@ -1,11 +1,11 @@ -# GoCryptoTrader package testdata +# GoCryptoTrader package Testdata [![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/ +[![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) diff --git a/tools/README.md b/tools/README.md index df1a0ab3..e7dacb41 100644 --- a/tools/README.md +++ b/tools/README.md @@ -1,11 +1,11 @@ -# GoCryptoTrader package tools +# GoCryptoTrader package Tools [![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/ +[![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) diff --git a/tools/documentation/documentation.go b/tools/documentation/documentation.go index 449af062..b395d1ed 100644 --- a/tools/documentation/documentation.go +++ b/tools/documentation/documentation.go @@ -7,6 +7,7 @@ import ( "log" "os" "strings" + "time" "github.com/thrasher-/gocryptotrader/common" ) @@ -31,7 +32,38 @@ const ( webPath = "..%s..%sweb%s" rootPath = "..%s..%s" + // exchange packages + alphapoint = "..%s..%sexchanges%salphapoint%s" + anx = "..%s..%sexchanges%sanx%s" + binance = "..%s..%sexchanges%sbinance%s" + bitfinex = "..%s..%sexchanges%sbitfinex%s" + bitflyer = "..%s..%sexchanges%sbitflyer%s" + bithumb = "..%s..%sexchanges%sbithumb%s" + bitstamp = "..%s..%sexchanges%sbitstamp%s" + bittrex = "..%s..%sexchanges%sbittrex%s" + btcc = "..%s..%sexchanges%sbtcc%s" + btcmarkets = "..%s..%sexchanges%sbtcmarkets%s" + coinut = "..%s..%sexchanges%scoinut%s" + exmo = "..%s..%sexchanges%sexmo%s" + gdax = "..%s..%sexchanges%sgdax%s" + gemini = "..%s..%sexchanges%sgemini%s" + hitbtc = "..%s..%sexchanges%shitbtc%s" + huobi = "..%s..%sexchanges%shuobi%s" + itbit = "..%s..%sexchanges%sitbit%s" + kraken = "..%s..%sexchanges%skraken%s" + lakebtc = "..%s..%sexchanges%slakebtc%s" + localbitcoins = "..%s..%sexchanges%slocalbitcoins%s" + okcoin = "..%s..%sexchanges%sokcoin%s" + okex = "..%s..%sexchanges%sokex%s" + poloniex = "..%s..%sexchanges%spoloniex%s" + wex = "..%s..%sexchanges%swex%s" + yobit = "..%s..%sexchanges%syobit%s" + liqui = "..%s..%sexchanges%sliqui%s" + contributorsList = "https://api.github.com/repos/thrasher-/gocryptotrader/contributors" + + licenseName = "LICENSE" + contributorName = "CONTRIBUTORS" ) var ( @@ -42,12 +74,16 @@ var ( tmpl *template.Template path string contributors []contributor + // exchanges []string{"alphapoint", "anx", "binance", "bitfinex", "bitflyer", + // "bithumb"} ) type readme struct { Name string Contributors []contributor NameURL string + Year int + CapitalName string } type contributor struct { @@ -149,24 +185,77 @@ func addPaths() { codebasePaths["tools"] = fmt.Sprintf(toolsPath, path, path, path) codebasePaths["web"] = fmt.Sprintf(webPath, path, path, path) codebasePaths["root"] = fmt.Sprintf(rootPath, path, path) + + codebasePaths["exchanges alphapoint"] = fmt.Sprintf(alphapoint, path, path, path, path) + codebasePaths["exchanges anx"] = fmt.Sprintf(anx, path, path, path, path) + codebasePaths["exchanges binance"] = fmt.Sprintf(binance, path, path, path, path) + codebasePaths["exchanges bitfinex"] = fmt.Sprintf(bitfinex, path, path, path, path) + codebasePaths["exchanges bitflyer"] = fmt.Sprintf(bitflyer, path, path, path, path) + codebasePaths["exchanges bithumb"] = fmt.Sprintf(bithumb, path, path, path, path) + codebasePaths["exchanges bitstamp"] = fmt.Sprintf(bitstamp, path, path, path, path) + codebasePaths["exchanges bittrex"] = fmt.Sprintf(bittrex, path, path, path, path) + codebasePaths["exchanges btcc"] = fmt.Sprintf(btcc, path, path, path, path) + codebasePaths["exchanges btcmarkets"] = fmt.Sprintf(btcmarkets, path, path, path, path) + codebasePaths["exchanges coinut"] = fmt.Sprintf(coinut, path, path, path, path) + codebasePaths["exchanges exmo"] = fmt.Sprintf(exmo, path, path, path, path) + codebasePaths["exchanges gdax"] = fmt.Sprintf(gdax, 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 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) + codebasePaths["exchanges liqui"] = fmt.Sprintf(liqui, path, path, path, path) + codebasePaths["exchanges localbitcoins"] = fmt.Sprintf(localbitcoins, path, path, path, path) + codebasePaths["exchanges okcoin"] = fmt.Sprintf(okcoin, path, path, path, path) + codebasePaths["exchanges okex"] = fmt.Sprintf(okex, path, path, path, path) + 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["CONTRIBUTORS"] = fmt.Sprintf(rootPath, path, path) + codebasePaths["LICENSE"] = fmt.Sprintf(rootPath, path, path) } func addReadmeData(packageName string) { readmeInfo := readme{ - Name: packageName, + Name: getName(packageName, false), Contributors: contributors, NameURL: getslashFromName(packageName), + Year: time.Now().Year(), + CapitalName: getName(packageName, true), } codebaseReadme[packageName] = readmeInfo } +func getName(name string, capital bool) string { + newStrings := strings.Split(name, " ") + if len(newStrings) > 1 { + if capital { + return getCapital(newStrings[1]) + } + return newStrings[1] + } + if capital { + return getCapital(name) + } + return name +} + +func getCapital(name string) string { + cap := strings.ToUpper(string(name[0])) + last := name[1:] + + return cap + last +} + // 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" { + if packageName == "testdata" || packageName == "tools" || packageName == contributorName || packageName == licenseName { return "" } return packageName @@ -182,6 +271,14 @@ func addTemplates() error { if err != nil { return err } + _, err = glob.ParseGlob(fmt.Sprintf("exchange_readme_templates%s*", path)) + if err != nil { + return err + } + _, err = glob.ParseGlob(fmt.Sprintf("general_templates%s*", path)) + if err != nil { + return err + } tmpl = glob return nil @@ -189,12 +286,22 @@ func addTemplates() error { // checkReadme checks to see if the file exists func checkReadme(packageName string) bool { + if packageName == licenseName || packageName == contributorName { + _, err := os.Stat(codebasePaths[packageName] + packageName) + return os.IsNotExist(err) + } _, err := os.Stat(codebasePaths[packageName] + "README.md") return os.IsNotExist(err) } // replaces readme file func replaceReadme(packageName string) error { + if packageName == licenseName || packageName == contributorName { + if err := deleteFile(codebasePaths[packageName] + packageName); err != nil { + return err + } + return createReadme(packageName) + } if err := deleteFile(codebasePaths[packageName] + "README.md"); err != nil { return err } @@ -203,6 +310,17 @@ func replaceReadme(packageName string) error { // creates new readme file and executes template func createReadme(packageName string) error { + if packageName == licenseName || packageName == contributorName { + file, err := os.Create(codebasePaths[packageName] + packageName) + defer file.Close() + if err != nil { + return err + } + if verbose { + fmt.Println("File done") + } + return tmpl.ExecuteTemplate(file, packageName, codebaseReadme[packageName]) + } file, err := os.Create(codebasePaths[packageName] + "README.md") defer file.Close() if err != nil { diff --git a/tools/documentation/exchange_readme_templates/alphapoint.tmpl b/tools/documentation/exchange_readme_templates/alphapoint.tmpl new file mode 100644 index 00000000..1dcefc88 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/alphapoint.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges alphapoint" -}} +{{template "header" .}} +## Alphapoint Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/anx.tmpl b/tools/documentation/exchange_readme_templates/anx.tmpl new file mode 100644 index 00000000..464ea7c8 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/anx.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges anx" -}} +{{template "header" .}} +## ANX Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/binance.tmpl b/tools/documentation/exchange_readme_templates/binance.tmpl new file mode 100644 index 00000000..f3b832c7 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/binance.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges binance" -}} +{{template "header" .}} +## Binance Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/bitfinex.tmpl b/tools/documentation/exchange_readme_templates/bitfinex.tmpl new file mode 100644 index 00000000..df6a92f9 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/bitfinex.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges bitfinex" -}} +{{template "header" .}} +## Bitfinex Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/bitflyer.tmpl b/tools/documentation/exchange_readme_templates/bitflyer.tmpl new file mode 100644 index 00000000..3c16331c --- /dev/null +++ b/tools/documentation/exchange_readme_templates/bitflyer.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges bitflyer" -}} +{{template "header" .}} +## Bitflyer Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/bithumb.tmpl b/tools/documentation/exchange_readme_templates/bithumb.tmpl new file mode 100644 index 00000000..f3c637b7 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/bithumb.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges bithumb" -}} +{{template "header" .}} +## Bithumb Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/bitstamp.tmpl b/tools/documentation/exchange_readme_templates/bitstamp.tmpl new file mode 100644 index 00000000..86c88652 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/bitstamp.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges bitstamp" -}} +{{template "header" .}} +## Bitstamp Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/bittrex.tmpl b/tools/documentation/exchange_readme_templates/bittrex.tmpl new file mode 100644 index 00000000..b84c8f92 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/bittrex.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges bittrex" -}} +{{template "header" .}} +## Bittrex Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/btcc.tmpl b/tools/documentation/exchange_readme_templates/btcc.tmpl new file mode 100644 index 00000000..51da03a2 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/btcc.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges btcc" -}} +{{template "header" .}} +## BTCC Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/btcmarkets.tmpl b/tools/documentation/exchange_readme_templates/btcmarkets.tmpl new file mode 100644 index 00000000..9c5310a2 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/btcmarkets.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges btcmarkets" -}} +{{template "header" .}} +## BTCMarkets Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/coinut.tmpl b/tools/documentation/exchange_readme_templates/coinut.tmpl new file mode 100644 index 00000000..21eda7ad --- /dev/null +++ b/tools/documentation/exchange_readme_templates/coinut.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges coinut" -}} +{{template "header" .}} +## Coinut Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/exmo.tmpl b/tools/documentation/exchange_readme_templates/exmo.tmpl new file mode 100644 index 00000000..79b09dc8 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/exmo.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges exmo" -}} +{{template "header" .}} +## Exmo Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/gdax.tmpl b/tools/documentation/exchange_readme_templates/gdax.tmpl new file mode 100644 index 00000000..a25173e0 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/gdax.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges gdax" -}} +{{template "header" .}} +## GDAX Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/gemini.tmpl b/tools/documentation/exchange_readme_templates/gemini.tmpl new file mode 100644 index 00000000..e2e642f8 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/gemini.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges gemini" -}} +{{template "header" .}} +## Gemini Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/hitbtc.tmpl b/tools/documentation/exchange_readme_templates/hitbtc.tmpl new file mode 100644 index 00000000..63f14ade --- /dev/null +++ b/tools/documentation/exchange_readme_templates/hitbtc.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges hitbtc" -}} +{{template "header" .}} +## HitBTC Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/huobi.tmpl b/tools/documentation/exchange_readme_templates/huobi.tmpl new file mode 100644 index 00000000..f05d10a4 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/huobi.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges huobi" -}} +{{template "header" .}} +## Huobi Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/itbit.tmpl b/tools/documentation/exchange_readme_templates/itbit.tmpl new file mode 100644 index 00000000..b4516424 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/itbit.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges itbit" -}} +{{template "header" .}} +## Itbit Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/kraken.tmpl b/tools/documentation/exchange_readme_templates/kraken.tmpl new file mode 100644 index 00000000..4975e68a --- /dev/null +++ b/tools/documentation/exchange_readme_templates/kraken.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges kraken" -}} +{{template "header" .}} +## Kraken Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/lakebtc.tmpl b/tools/documentation/exchange_readme_templates/lakebtc.tmpl new file mode 100644 index 00000000..f5f225e0 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/lakebtc.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges lakebtc" -}} +{{template "header" .}} +## LakeBTC Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/liqui.tmpl b/tools/documentation/exchange_readme_templates/liqui.tmpl new file mode 100644 index 00000000..0f768994 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/liqui.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges liqui" -}} +{{template "header" .}} +## Liqui Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/localbitcoins.tmpl b/tools/documentation/exchange_readme_templates/localbitcoins.tmpl new file mode 100644 index 00000000..a88265d9 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/localbitcoins.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges localbitcoins" -}} +{{template "header" .}} +## LocalBitcoins Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/okcoin.tmpl b/tools/documentation/exchange_readme_templates/okcoin.tmpl new file mode 100644 index 00000000..c732f595 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/okcoin.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges okcoin" -}} +{{template "header" .}} +## OKCoin Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/okex.tmpl b/tools/documentation/exchange_readme_templates/okex.tmpl new file mode 100644 index 00000000..bc0d482e --- /dev/null +++ b/tools/documentation/exchange_readme_templates/okex.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges okex" -}} +{{template "header" .}} +## OKex Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/poloniex.tmpl b/tools/documentation/exchange_readme_templates/poloniex.tmpl new file mode 100644 index 00000000..30bd1a08 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/poloniex.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges poloniex" -}} +{{template "header" .}} +## Poloniex Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/wex.tmpl b/tools/documentation/exchange_readme_templates/wex.tmpl new file mode 100644 index 00000000..a4637dc4 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/wex.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges wex" -}} +{{template "header" .}} +## Wex Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/exchange_readme_templates/yobit.tmpl b/tools/documentation/exchange_readme_templates/yobit.tmpl new file mode 100644 index 00000000..8cb95788 --- /dev/null +++ b/tools/documentation/exchange_readme_templates/yobit.tmpl @@ -0,0 +1,12 @@ +{{define "exchanges yobit" -}} +{{template "header" .}} +## Yobit Exchange + +### Current Features + ++ Initial generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/general_templates/CONTRIBUTORS b/tools/documentation/general_templates/CONTRIBUTORS new file mode 100644 index 00000000..eda72237 --- /dev/null +++ b/tools/documentation/general_templates/CONTRIBUTORS @@ -0,0 +1,6 @@ +{{define "CONTRIBUTORS"}} +Thanks to the following contributors: +{{ range $contributor := .Contributors -}} +{{$contributor.Login}} | {{$contributor.URL}} +{{ end }} +{{end}} diff --git a/tools/documentation/general_templates/LICENSE b/tools/documentation/general_templates/LICENSE new file mode 100644 index 00000000..c8eb724e --- /dev/null +++ b/tools/documentation/general_templates/LICENSE @@ -0,0 +1,23 @@ +{{define "LICENSE" -}} +The MIT License (MIT) + +Copyright (c) 2014-{{- .Year}} The GoCryptoTrader Developers + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +{{end}} diff --git a/tools/documentation/sub_templates/contributors.tmpl b/tools/documentation/sub_templates/contributors.tmpl index 123c6ca4..0d124405 100644 --- a/tools/documentation/sub_templates/contributors.tmpl +++ b/tools/documentation/sub_templates/contributors.tmpl @@ -1,6 +1,8 @@ {{define "contributors"}} ## Contributor List +### A very special thank you to all who have contributed to this program: + |User|Github|Contribution Amount| |--|--|--| {{ range $contributor := .Contributors -}} diff --git a/tools/documentation/sub_templates/header.tmpl b/tools/documentation/sub_templates/header.tmpl index b6144bd8..80686851 100644 --- a/tools/documentation/sub_templates/header.tmpl +++ b/tools/documentation/sub_templates/header.tmpl @@ -1,5 +1,5 @@ {{define "header" -}} -# GoCryptoTrader package {{.Name}} +# GoCryptoTrader package {{.CapitalName}} diff --git a/web/README.md b/web/README.md index 9991ecda..272928b3 100644 --- a/web/README.md +++ b/web/README.md @@ -1,4 +1,4 @@ -# GoCryptoTrader package web +# GoCryptoTrader package Web