forked from thrasher-corp/gocryptotrader
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added new base documentation using documentation tool
- Loading branch information
Showing
17 changed files
with
766 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # GoCryptoTrader package common | ||
|
|
||
| <img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70"> | ||
|
|
||
|
|
||
| [](https://travis-ci.org/thrasher-/gocryptotrader) | ||
| [](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) | ||
| [](https://godoc.org/github.com/thrasher-/gocryptotrader/common) | ||
| [](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) | ||
| [](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) | ||
|
|
||
|
|
||
| This common 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/) | ||
|
|
||
| ## Current Features for common | ||
|
|
||
| + This package collates basic broad functions that are used throughout this codebase | ||
|
|
||
| ### Please click GoDocs chevron above to view current GoDoc information for this package | ||
|
|
||
| ## 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 | ||
|
|
||
| <img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/early-dumb-donate.png?raw=true" hspace="70"> | ||
|
|
||
| If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: | ||
|
|
||
| ***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # GoCryptoTrader package config | ||
|
|
||
| <img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70"> | ||
|
|
||
|
|
||
| [](https://travis-ci.org/thrasher-/gocryptotrader) | ||
| [](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) | ||
| [](https://godoc.org/github.com/thrasher-/gocryptotrader/config) | ||
| [](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) | ||
| [](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) | ||
|
|
||
|
|
||
| This config 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/) | ||
|
|
||
| ## Current Features for config | ||
|
|
||
| + This package deals with configuration utilities | ||
|
|
||
| ### 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 | ||
|
|
||
| <img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/early-dumb-donate.png?raw=true" hspace="70"> | ||
|
|
||
| If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: | ||
|
|
||
| ***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # GoCryptoTrader package currency | ||
|
|
||
| <img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70"> | ||
|
|
||
|
|
||
| [](https://travis-ci.org/thrasher-/gocryptotrader) | ||
| [](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) | ||
| [](https://godoc.org/github.com/thrasher-/gocryptotrader/currency) | ||
| [](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) | ||
| [](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) | ||
|
|
||
|
|
||
| This currency 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/) | ||
|
|
||
| ## Current Features for currency | ||
|
|
||
| + Currency package deals with currency pair generation, manipulation and tracking | ||
|
|
||
| ### 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 | ||
|
|
||
| <img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/early-dumb-donate.png?raw=true" hspace="70"> | ||
|
|
||
| If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: | ||
|
|
||
| ***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # GoCryptoTrader package currency pair | ||
|
|
||
| <img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70"> | ||
|
|
||
|
|
||
| [](https://travis-ci.org/thrasher-/gocryptotrader) | ||
| [](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) | ||
| [](https://godoc.org/github.com/thrasher-/gocryptotrader/currency pair) | ||
| [](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) | ||
| [](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) | ||
|
|
||
|
|
||
| This currency pair package is part of the GoCryptoTrader codebase | ||
|
|
||
| ## This 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/) | ||
|
|
||
| ## Current Features for currency pair | ||
|
|
||
| + This package services the currency package | ||
|
|
||
| ### 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 | ||
|
|
||
| <img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/early-dumb-donate.png?raw=true" hspace="70"> | ||
|
|
||
| If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: | ||
|
|
||
| ***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # GoCryptoTrader package currency symbol | ||
|
|
||
| <img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70"> | ||
|
|
||
|
|
||
| [](https://travis-ci.org/thrasher-/gocryptotrader) | ||
| [](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) | ||
| [](https://godoc.org/github.com/thrasher-/gocryptotrader/currency symbol) | ||
| [](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) | ||
| [](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) | ||
|
|
||
|
|
||
| This currency symbol package is part of the GoCryptoTrader codebase | ||
|
|
||
| ## This 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/) | ||
|
|
||
| ## Current Features for currency symbol | ||
|
|
||
| + This package services the currency package | ||
|
|
||
| ### 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 | ||
|
|
||
| <img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/early-dumb-donate.png?raw=true" hspace="70"> | ||
|
|
||
| If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: | ||
|
|
||
| ***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # GoCryptoTrader package currency translation | ||
|
|
||
| <img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70"> | ||
|
|
||
|
|
||
| [](https://travis-ci.org/thrasher-/gocryptotrader) | ||
| [](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) | ||
| [](https://godoc.org/github.com/thrasher-/gocryptotrader/currency translation) | ||
| [](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) | ||
| [](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) | ||
|
|
||
|
|
||
| This currency translation package is part of the GoCryptoTrader codebase | ||
|
|
||
| ## This 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/) | ||
|
|
||
| ## Current Features for currency translation | ||
|
|
||
| + This package services the currency package with translation functions | ||
|
|
||
| ### 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 | ||
|
|
||
| <img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/early-dumb-donate.png?raw=true" hspace="70"> | ||
|
|
||
| If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: | ||
|
|
||
| ***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # GoCryptoTrader package events | ||
|
|
||
| <img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70"> | ||
|
|
||
|
|
||
| [](https://travis-ci.org/thrasher-/gocryptotrader) | ||
| [](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) | ||
| [](https://godoc.org/github.com/thrasher-/gocryptotrader/events) | ||
| [](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) | ||
| [](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) | ||
|
|
||
|
|
||
| This events 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/) | ||
|
|
||
| ## Current Features for events | ||
|
|
||
| + The events package handles events from GoCryptoTrader bot | ||
|
|
||
| ### 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 | ||
|
|
||
| <img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/early-dumb-donate.png?raw=true" hspace="70"> | ||
|
|
||
| If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: | ||
|
|
||
| ***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** | ||
|
|
Oops, something went wrong.