diff --git a/cmd/documentation/README.md b/cmd/documentation/README.md index e32e6a55..e6fb031f 100644 --- a/cmd/documentation/README.md +++ b/cmd/documentation/README.md @@ -95,4 +95,3 @@ When submitting a PR, please abide by our coding guidelines: 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/cmd/documentation/currency_templates/fx_currencyconverterapi.tmpl b/cmd/documentation/currency_templates/fx_currencyconverterapi.tmpl index bad1a573..d6da5a20 100644 --- a/cmd/documentation/currency_templates/fx_currencyconverterapi.tmpl +++ b/cmd/documentation/currency_templates/fx_currencyconverterapi.tmpl @@ -1,4 +1,4 @@ -{{define "currency forexprovider currencyconverter" -}} +{{define "currency forexprovider currencyconverterapi" -}} {{template "header" .}} ## Current Features for {{.Name}} @@ -11,15 +11,15 @@ + Individual package example below: ```go import ( -"github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" -"github.com/thrasher-corp/gocryptotrader/currency/forexprovider/currencyconverter" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/currencyconverter" ) c := currencyconverter.CurrencyConverter{} // Define configuration newSettings := base.Settings{ - Name: "CurrencyConverter", + Name: "CurrencyConverter", Enabled: true, Verbose: false, RESTPollingDelay: time.Duration, diff --git a/cmd/documentation/currency_templates/fx_currencylayer.tmpl b/cmd/documentation/currency_templates/fx_currencylayer.tmpl index e96a1513..b2654fd9 100644 --- a/cmd/documentation/currency_templates/fx_currencylayer.tmpl +++ b/cmd/documentation/currency_templates/fx_currencylayer.tmpl @@ -11,15 +11,15 @@ + Individual package example below: ```go import ( -"github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" -"github.com/thrasher-corp/gocryptotrader/currency/forexprovider/currencylayer" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/currencylayer" ) c := currencylayer.CurrencyLayer{} // Define configuration newSettings := base.Settings{ - Name: "CurrencyLayer", + Name: "CurrencyLayer", Enabled: true, Verbose: false, RESTPollingDelay: time.Duration, diff --git a/cmd/documentation/currency_templates/fx_exchangeratesapi.tmpl b/cmd/documentation/currency_templates/fx_exchangeratesapi.tmpl new file mode 100644 index 00000000..49830305 --- /dev/null +++ b/cmd/documentation/currency_templates/fx_exchangeratesapi.tmpl @@ -0,0 +1,40 @@ +{{define "currency forexprovider exchangeratesapi.io" -}} +{{template "header" .}} +## Current Features for {{.Name}} + ++ Fetches up to date curency data from [Exchange rates API]("http://exchangeratesapi.io") + +### How to enable + ++ [Enable via configuration](https://github.com/thrasher-corp/gocryptotrader/tree/master/config#enable-currency-via-config-example) + ++ Individual package example below: +```go +import ( + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/exchangerates" +) + +c := exchangerates.ExchangeRates{} + +// Define configuration +newSettings := base.Settings{ + Name: "ExchangeRates", + Enabled: true, + Verbose: false, + RESTPollingDelay: time.Duration, + APIKey: "key", + APIKeyLvl: "keylvl", + PrimaryProvider: true, +} + +c.Setup(newSettings) + +mapstringfloat, err := c.GetRates("USD", "EUR,CHY") +// Handle error +``` + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{- end}} \ No newline at end of file diff --git a/cmd/documentation/currency_templates/fx_fixer.tmpl b/cmd/documentation/currency_templates/fx_fixer.tmpl index 346e9b31..60a1e4dd 100644 --- a/cmd/documentation/currency_templates/fx_fixer.tmpl +++ b/cmd/documentation/currency_templates/fx_fixer.tmpl @@ -1,4 +1,4 @@ -{{define "currency forexprovider fixer" -}} +{{define "currency forexprovider fixer.io" -}} {{template "header" .}} ## Current Features for {{.Name}} @@ -11,15 +11,15 @@ + Individual package example below: ```go import ( -"github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" -"github.com/thrasher-corp/gocryptotrader/currency/forexprovider/fixer.io" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/fixer.io" ) c := fixer.Fixer{} // Define configuration newSettings := base.Settings{ - Name: "Fixer", + Name: "Fixer", Enabled: true, Verbose: false, RESTPollingDelay: time.Duration, diff --git a/cmd/documentation/currency_templates/fx_openexchangerates.tmpl b/cmd/documentation/currency_templates/fx_openexchangerates.tmpl index 72dbd7c3..372e1936 100644 --- a/cmd/documentation/currency_templates/fx_openexchangerates.tmpl +++ b/cmd/documentation/currency_templates/fx_openexchangerates.tmpl @@ -11,15 +11,15 @@ + Individual package example below: ```go import ( -"github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" -"github.com/thrasher-corp/gocryptotrader/currency/forexprovider/openexchangerates" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/openexchangerates" ) c := openexchangerates.OXR{} // Define configuration newSettings := base.Settings{ - Name: "openexchangerates", + Name: "openexchangerates", Enabled: true, Verbose: false, RESTPollingDelay: time.Duration, diff --git a/cmd/documentation/documentation.go b/cmd/documentation/documentation.go index 5267e306..1b7fe352 100644 --- a/cmd/documentation/documentation.go +++ b/cmd/documentation/documentation.go @@ -19,7 +19,7 @@ import ( const ( // DefaultRepo is the main example repository - DefaultRepo = "https://api.github.com/repos/[REPO ADDRESS HERE]" + DefaultRepo = "https://api.github.com/repos/thrasher-corp/gocryptotrader" // GithubAPIEndpoint allows the program to query your repository // contributor list @@ -32,6 +32,39 @@ const ( ContributorFile = "CONTRIBUTORS" ) +var ( + // DefaultExcludedDirectories defines the basic directory exclusion list for GCT + DefaultExcludedDirectories = []string{".github", + ".git", + "node_modules", + ".vscode", + ".idea", + "cmd_templates", + "common_templates", + "communications_templates", + "config_templates", + "currency_templates", + "events_templates", + "exchanges_templates", + "portfolio_templates", + "root_templates", + "sub_templates", + "testdata_templates", + "tools_templates", + "web_templates", + } + + // global flag for verbosity + verbose bool + // current tool directory to specify working templates + toolDir string + // exposes root directory if outside of document tool directory + repoDir string + // is a broken down version of the documentation tool dir for cross platform + // checking + ref = []string{"gocryptotrader", "cmd", "documentation"} +) + // Contributor defines an account associated with this code base by doing // contributions type Contributor struct { @@ -43,12 +76,11 @@ type Contributor struct { // Config defines the running config to deploy documentation across a github // repository including exclusion lists for files and directories type Config struct { - GithubRepo string `json:"githubRepo"` - Exclusions Exclusions `json:"exclusionList"` - RootReadme bool `json:"rootReadmeActive"` - LicenseFile bool `json:"licenseFileActive"` - ContributorFile bool `json:"contributorFileActive"` - ReferencePathToRepo string `json:"referencePathToRepo"` + GithubRepo string `json:"githubRepo"` + Exclusions Exclusions `json:"exclusionList"` + RootReadme bool `json:"rootReadmeActive"` + LicenseFile bool `json:"licenseFileActive"` + ContributorFile bool `json:"contributorFileActive"` } // Exclusions defines the exclusion list so documents are not generated @@ -62,7 +94,6 @@ type DocumentationDetails struct { Directories []string Tmpl *template.Template Contributors []Contributor - Verbose bool Config *Config } @@ -77,15 +108,33 @@ type Attributes struct { } func main() { - verbose := flag.Bool("v", false, "Verbose output") - + flag.BoolVar(&verbose, "v", false, "Verbose output") + flag.StringVar(&toolDir, "tooldir", "", "Pass in the documentation tool directory if outside tool folder") flag.Parse() + wd, err := os.Getwd() + if err != nil { + fmt.Println("Documentation tool error cannot get working dir:", err) + os.Exit(1) + } + + if strings.Contains(wd, filepath.Join(ref...)) { + rootdir := filepath.Dir(filepath.Dir(wd)) + repoDir = rootdir + toolDir = wd + } else { + if toolDir == "" { + fmt.Println("Please set documentation tool directory via the tooldir flag if working outside of tool directory") + os.Exit(1) + } + repoDir = wd + } + fmt.Println(core.Banner) fmt.Println("This will update and regenerate documentation for the different packages in your repo.") fmt.Println() - if *verbose { + if verbose { fmt.Println("Fetching configuration...") } @@ -95,11 +144,11 @@ func main() { err) } - if *verbose { + if verbose { fmt.Println("Fetching project directory tree...") } - dirList, err := GetProjectDirectoryTree(&config, *verbose) + dirList, err := GetProjectDirectoryTree(&config) if err != nil { log.Fatalf("Documentation Generation Tool - GetProjectDirectoryTree error %s", err) @@ -107,7 +156,7 @@ func main() { var contributors []Contributor if config.ContributorFile { - if *verbose { + if verbose { fmt.Println("Fetching repository contributor list...") } contributors, err = GetContributorList(config.GithubRepo) @@ -116,16 +165,15 @@ func main() { err) } - // idoall's contributors were forked and merged, so his contributions - // aren't automatically retrievable - contributors = append(contributors, Contributor{ - Login: "idoall", - URL: "https://github.com/idoall", - Contributions: 1, - }) - // Github API missing contributors - missingAPIContributors := []Contributor{ + contributors = append(contributors, []Contributor{ + // idoall's contributors were forked and merged, so his contributions + // aren't automatically retrievable + { + Login: "idoall", + URL: "https://github.com/idoall", + Contributions: 1, + }, { Login: "mattkanwisher", URL: "https://github.com/mattkanwisher", @@ -151,10 +199,9 @@ func main() { URL: "https://github.com/zeldrinn", Contributions: 1, }, - } - contributors = append(contributors, missingAPIContributors...) + }...) - if *verbose { + if verbose { fmt.Println("Contributor List Fetched") for i := range contributors { fmt.Println(contributors[i].Login) @@ -164,7 +211,7 @@ func main() { fmt.Println("Contributor list file disabled skipping fetching details") } - if *verbose { + if verbose { fmt.Println("Fetching template files...") } @@ -174,7 +221,7 @@ func main() { err) } - if *verbose { + if verbose { fmt.Println("All core systems fetched, updating documentation...") } @@ -182,7 +229,6 @@ func main() { dirList, tmpl, contributors, - *verbose, &config}) if err != nil { log.Fatalf("Documentation Generation Tool - UpdateDocumentation error %s", @@ -195,11 +241,12 @@ func main() { // GetConfiguration retrieves the documentation configuration func GetConfiguration() (Config, error) { var c Config - file, err := os.OpenFile("config.json", os.O_RDWR, os.ModePerm) + configFilePath := filepath.Join([]string{toolDir, "config.json"}...) + file, err := os.OpenFile(configFilePath, os.O_RDWR, os.ModePerm) if err != nil { - fmt.Println("Creating configuration file, please add github repository path and preferences") + fmt.Println("Creating configuration file, please check to add a different github repository path and change preferences") - file, err = os.Create("config.json") + file, err = os.Create(configFilePath) if err != nil { return c, err } @@ -209,8 +256,7 @@ func GetConfiguration() (Config, error) { c.ContributorFile = true c.LicenseFile = true c.RootReadme = true - c.ReferencePathToRepo = "../../" - c.Exclusions.Directories = []string{".github"} + c.Exclusions.Directories = DefaultExcludedDirectories data, mErr := json.MarshalIndent(c, "", " ") if mErr != nil { @@ -235,21 +281,17 @@ func GetConfiguration() (Config, error) { return c, err } - if c.GithubRepo == "" || c.GithubRepo == DefaultRepo { + if c.GithubRepo == "" { return c, errors.New("repository not set in config.json file, please change") } - if c.ReferencePathToRepo == "" { - return c, errors.New("reference path not set in the config.json file, please set") - } - return c, nil } // IsExcluded returns if the file path is included in the exclusion list func IsExcluded(path string, exclusion []string) bool { - for _, data := range exclusion { - if strings.Contains(path, data) { + for i := range exclusion { + if path == exclusion[i] { return true } } @@ -258,18 +300,18 @@ func IsExcluded(path string, exclusion []string) bool { // GetProjectDirectoryTree uses filepath walk functions to get each individual // directory name and path to match templates with -func GetProjectDirectoryTree(c *Config, verbose bool) ([]string, error) { +func GetProjectDirectoryTree(c *Config) ([]string, error) { var directoryData []string if c.RootReadme { // Projects root README.md - directoryData = append(directoryData, c.ReferencePathToRepo) + directoryData = append(directoryData, repoDir) } if c.LicenseFile { // Standard license file - directoryData = append(directoryData, c.ReferencePathToRepo+LicenseFile) + directoryData = append(directoryData, filepath.Join(repoDir, LicenseFile)) } if c.ContributorFile { // Standard contributor file - directoryData = append(directoryData, c.ReferencePathToRepo+ContributorFile) + directoryData = append(directoryData, filepath.Join(repoDir, ContributorFile)) } walkfn := func(path string, info os.FileInfo, err error) error { @@ -293,7 +335,7 @@ func GetProjectDirectoryTree(c *Config, verbose bool) ([]string, error) { return nil } - return directoryData, filepath.Walk(c.ReferencePathToRepo, walkfn) + return directoryData, filepath.Walk(repoDir, walkfn) } // GetTemplateFiles parses and returns all template files in the documentation @@ -313,6 +355,9 @@ func GetTemplateFiles() (*template.Template, error) { var parseError error tmpl, parseError = tmpl.ParseGlob(filepath.Join(path, "*.tmpl")) if parseError != nil { + if strings.Contains(parseError.Error(), "pattern matches no files") { + return nil + } return parseError } return filepath.SkipDir @@ -320,7 +365,7 @@ func GetTemplateFiles() (*template.Template, error) { return nil } - return tmpl, filepath.Walk(".", walkfn) + return tmpl, filepath.Walk(toolDir, walkfn) } // GetContributorList fetches a list of contributors from the github api @@ -371,18 +416,23 @@ func GetGoDocURL(name string) string { // UpdateDocumentation generates or updates readme/documentation files across // the codebase func UpdateDocumentation(details DocumentationDetails) error { - for _, path := range details.Directories { - data := strings.Split(path, "/") + for i := range details.Directories { + cutset := details.Directories[i][len(repoDir):] + if cutset != "" && cutset[0] == os.PathSeparator { + cutset = cutset[1:] + } + + data := strings.Split(cutset, string(os.PathSeparator)) + var temp []string - for _, d := range data { - if d == ".." { + for x := range data { + if data[x] == ".." { continue } - if d == "" { + if data[x] == "" { break } - - temp = append(temp, d) + temp = append(temp, data[x]) } var name string @@ -393,7 +443,7 @@ func UpdateDocumentation(details DocumentationDetails) error { } if IsExcluded(name, details.Config.Exclusions.Files) { - if details.Verbose { + if verbose { fmt.Println("Excluding file:", name) } continue @@ -401,20 +451,21 @@ func UpdateDocumentation(details DocumentationDetails) error { if details.Tmpl.Lookup(name) == nil { fmt.Printf("Template not found for path %s create new template with {{define \"%s\" -}} TEMPLATE HERE {{end}}\n", - path, + details.Directories[i], name) continue } var mainPath string if name == LicenseFile || name == ContributorFile { - mainPath = path + mainPath = details.Directories[i] } else { - mainPath = filepath.Join(path, "README.md") + mainPath = filepath.Join(details.Directories[i], "README.md") } err := os.Remove(mainPath) - if err != nil && !strings.Contains(err.Error(), "no such file or directory") { + if err != nil && !(strings.Contains(err.Error(), "no such file or directory") || + strings.Contains(err.Error(), "The system cannot find the file specified.")) { return err } @@ -422,14 +473,15 @@ func UpdateDocumentation(details DocumentationDetails) error { if err != nil { return err } - defer file.Close() attr := GetDocumentationAttributes(name, details.Contributors) err = details.Tmpl.ExecuteTemplate(file, name, attr) if err != nil { + file.Close() return err } + file.Close() } return nil } diff --git a/cmd/documentation/exchanges_templates/btcmarkets.tmpl b/cmd/documentation/exchanges_templates/btcmarkets.tmpl index 83350473..4d81557e 100644 --- a/cmd/documentation/exchanges_templates/btcmarkets.tmpl +++ b/cmd/documentation/exchanges_templates/btcmarkets.tmpl @@ -5,6 +5,7 @@ ### Current Features + REST Support ++ Websocket Support ### How to enable diff --git a/cmd/documentation/exchanges_templates/btse.tmpl b/cmd/documentation/exchanges_templates/btse.tmpl new file mode 100644 index 00000000..9df4638f --- /dev/null +++ b/cmd/documentation/exchanges_templates/btse.tmpl @@ -0,0 +1,99 @@ +{{define "exchanges btse" -}} +{{template "header" .}} +## BTCMarkets Exchange + +### Current Features + ++ REST Support ++ Websocket Support + +### How to enable + ++ [Enable via configuration](https://github.com/thrasher-corp/gocryptotrader/tree/master/config#enable-exchange-via-config-example) + ++ Individual package example below: + +```go + // Exchanges will be abstracted out in further updates and examples will be + // supplied then +``` + +### How to do REST public/private calls + ++ If enabled via "configuration".json file the exchange will be added to the +IBotExchange array in the ```go var bot Bot``` and you will only be able to use +the wrapper interface functions for accessing exchange data. View routines.go +for an example of integration usage with GoCryptoTrader. Rudimentary example +below: + +main.go +```go +var b exchange.IBotExchange + +for i := range bot.Exchanges { + if bot.Exchanges[i].GetName() == "BTSE" { + b = bot.Exchanges[i] + } +} + +// Public calls - wrapper functions + +// Fetches current ticker information +tick, err := b.FetchTicker() +if err != nil { + // Handle error +} + +// Fetches current orderbook information +ob, err := b.FetchOrderbook() +if err != nil { + // Handle error +} + +// Private calls - wrapper functions - make sure your APIKEY and APISECRET are +// set and AuthenticatedAPISupport is set to true + +// Fetches current account information +accountInfo, err := b.GetAccountInfo() +if err != nil { + // Handle error +} +``` + ++ If enabled via individually importing package, rudimentary example below: + +```go +// Public calls + +// Fetches current ticker information +ticker, err := b.GetTicker() +if err != nil { + // Handle error +} + +// Fetches current orderbook information +ob, err := b.GetOrderBook() +if err != nil { + // Handle error +} + +// Private calls - make sure your APIKEY and APISECRET are set and +// AuthenticatedAPISupport is set to true + +// GetUserInfo returns account info +accountInfo, err := b.GetUserInfo(...) +if err != nil { + // Handle error +} + +// Submits an order and the exchange and returns its tradeID +tradeID, err := b.Trade(...) +if err != nil { + // Handle error +} +``` + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/cmd/documentation/root_templates/CONTRIBUTORS.tmpl b/cmd/documentation/root_templates/CONTRIBUTORS.tmpl index fa2ba817..0a25998d 100644 --- a/cmd/documentation/root_templates/CONTRIBUTORS.tmpl +++ b/cmd/documentation/root_templates/CONTRIBUTORS.tmpl @@ -3,4 +3,4 @@ Thanks to the following contributors: {{range $contributor := .Contributors -}} {{$contributor.Login}} | {{$contributor.URL}} {{end}} -{{end}} +{{- end}} diff --git a/cmd/documentation/root_templates/root_readme.tmpl b/cmd/documentation/root_templates/root_readme.tmpl index 3d7ca831..ec6f5159 100644 --- a/cmd/documentation/root_templates/root_readme.tmpl +++ b/cmd/documentation/root_templates/root_readme.tmpl @@ -133,4 +133,4 @@ If this framework helped you in any way, or you would like to support the develo Binaries will be published once the codebase reaches a stable condition. {{template "contributors" .}} -{{end}} +{{- end}} diff --git a/cmd/documentation/sub_templates/contributors.tmpl b/cmd/documentation/sub_templates/contributors.tmpl index 1051ea3b..35c8c455 100644 --- a/cmd/documentation/sub_templates/contributors.tmpl +++ b/cmd/documentation/sub_templates/contributors.tmpl @@ -5,7 +5,7 @@ |User|Contribution Amount| |--|--| -{{- range $contributor := .Contributors -}} +{{range $contributor := .Contributors -}} | [{{$contributor.Login}}]({{$contributor.URL}}) | {{$contributor.Contributions}} | {{end}} -{{end}} +{{- end}} diff --git a/cmd/documentation/sub_templates/donations.tmpl b/cmd/documentation/sub_templates/donations.tmpl index a864ed70..3fd5682f 100644 --- a/cmd/documentation/sub_templates/donations.tmpl +++ b/cmd/documentation/sub_templates/donations.tmpl @@ -6,4 +6,4 @@ If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: ***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** -{{end}} +{{- end}} diff --git a/common/README.md b/common/README.md index bb47fcca..d7c634d0 100644 --- a/common/README.md +++ b/common/README.md @@ -55,4 +55,3 @@ When submitting a PR, please abide by our coding guidelines: 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/communications/base/README.md b/communications/base/README.md index 1802f1df..dd3655be 100644 --- a/communications/base/README.md +++ b/communications/base/README.md @@ -44,4 +44,3 @@ When submitting a PR, please abide by our coding guidelines: 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/communications/slack/README.md b/communications/slack/README.md index 39b1675d..b68f14d1 100644 --- a/communications/slack/README.md +++ b/communications/slack/README.md @@ -92,4 +92,3 @@ When submitting a PR, please abide by our coding guidelines: 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/communications/smsglobal/README.md b/communications/smsglobal/README.md index 04cf4cb4..938ef324 100644 --- a/communications/smsglobal/README.md +++ b/communications/smsglobal/README.md @@ -77,4 +77,3 @@ When submitting a PR, please abide by our coding guidelines: 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/communications/telegram/README.md b/communications/telegram/README.md index 3163302b..eff3ee88 100644 --- a/communications/telegram/README.md +++ b/communications/telegram/README.md @@ -92,4 +92,3 @@ When submitting a PR, please abide by our coding guidelines: 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/config/README.md b/config/README.md index 70772f5a..73ee7e7d 100644 --- a/config/README.md +++ b/config/README.md @@ -249,4 +249,3 @@ When submitting a PR, please abide by our coding guidelines: 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/currency/README.md b/currency/README.md index 90d66ea3..a7a75f08 100644 --- a/currency/README.md +++ b/currency/README.md @@ -46,4 +46,3 @@ When submitting a PR, please abide by our coding guidelines: 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/currency/forexprovider/README.md b/currency/forexprovider/README.md index 84874e23..aaad1106 100644 --- a/currency/forexprovider/README.md +++ b/currency/forexprovider/README.md @@ -45,4 +45,3 @@ When submitting a PR, please abide by our coding guidelines: 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/currency/forexprovider/base/README.md b/currency/forexprovider/base/README.md index 5dfe1e1d..30b5e707 100644 --- a/currency/forexprovider/base/README.md +++ b/currency/forexprovider/base/README.md @@ -43,4 +43,3 @@ When submitting a PR, please abide by our coding guidelines: 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/currency/forexprovider/currencyconverterapi/README.md b/currency/forexprovider/currencyconverterapi/README.md index 8df13b14..cca5b1d3 100644 --- a/currency/forexprovider/currencyconverterapi/README.md +++ b/currency/forexprovider/currencyconverterapi/README.md @@ -5,7 +5,7 @@ [![Build Status](https://travis-ci.org/thrasher-corp/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-corp/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-corp/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-corp/gocryptotrader/currency/forexprovider/currencyconverter) +[![GoDoc](https://godoc.org/github.com/thrasher-corp/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-corp/gocryptotrader/currency/forexprovider/currencyconverterapi) [![Coverage Status](http://codecov.io/github/thrasher-corp/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-corp/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-corp/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader) @@ -29,15 +29,15 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader + Individual package example below: ```go import ( -"github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" -"github.com/thrasher-corp/gocryptotrader/currency/forexprovider/currencyconverter" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/currencyconverter" ) c := currencyconverter.CurrencyConverter{} // Define configuration newSettings := base.Settings{ - Name: "CurrencyConverter", + Name: "CurrencyConverter", Enabled: true, Verbose: false, RESTPollingDelay: time.Duration, @@ -72,4 +72,3 @@ When submitting a PR, please abide by our coding guidelines: 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/currency/forexprovider/currencylayer/README.md b/currency/forexprovider/currencylayer/README.md index b18bfb9b..37d76211 100644 --- a/currency/forexprovider/currencylayer/README.md +++ b/currency/forexprovider/currencylayer/README.md @@ -29,15 +29,15 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader + Individual package example below: ```go import ( -"github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" -"github.com/thrasher-corp/gocryptotrader/currency/forexprovider/currencylayer" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/currencylayer" ) c := currencylayer.CurrencyLayer{} // Define configuration newSettings := base.Settings{ - Name: "CurrencyLayer", + Name: "CurrencyLayer", Enabled: true, Verbose: false, RESTPollingDelay: time.Duration, @@ -72,4 +72,3 @@ When submitting a PR, please abide by our coding guidelines: 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/currency/forexprovider/exchangeratesapi.io/README.md b/currency/forexprovider/exchangeratesapi.io/README.md new file mode 100644 index 00000000..793f5466 --- /dev/null +++ b/currency/forexprovider/exchangeratesapi.io/README.md @@ -0,0 +1,74 @@ +# GoCryptoTrader package Forexprovider + + + + +[![Build Status](https://travis-ci.org/thrasher-corp/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-corp/gocryptotrader) +[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE) +[![GoDoc](https://godoc.org/github.com/thrasher-corp/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-corp/gocryptotrader/currency/forexprovider/exchangeratesapi.io) +[![Coverage Status](http://codecov.io/github/thrasher-corp/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-corp/gocryptotrader?branch=master) +[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-corp/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader) + + +This forexprovider 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://join.slack.com/t/gocryptotrader/shared_invite/enQtNTQ5NDAxMjA2Mjc5LTc5ZDE1ZTNiOGM3ZGMyMmY1NTAxYWZhODE0MWM5N2JlZDk1NDU0YTViYzk4NTk3OTRiMDQzNGQ1YTc4YmRlMTk) + +## Current Features for forexprovider + ++ Fetches up to date curency data from [Exchange rates API]("http://exchangeratesapi.io") + +### How to enable + ++ [Enable via configuration](https://github.com/thrasher-corp/gocryptotrader/tree/master/config#enable-currency-via-config-example) + ++ Individual package example below: +```go +import ( + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/exchangerates" +) + +c := exchangerates.ExchangeRates{} + +// Define configuration +newSettings := base.Settings{ + Name: "ExchangeRates", + Enabled: true, + Verbose: false, + RESTPollingDelay: time.Duration, + APIKey: "key", + APIKeyLvl: "keylvl", + PrimaryProvider: true, +} + +c.Setup(newSettings) + +mapstringfloat, err := c.GetRates("USD", "EUR,CHY") +// Handle error +``` + +### 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-corp/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*** \ No newline at end of file diff --git a/currency/forexprovider/fixer.io/README.md b/currency/forexprovider/fixer.io/README.md index 1ec733db..135caff4 100644 --- a/currency/forexprovider/fixer.io/README.md +++ b/currency/forexprovider/fixer.io/README.md @@ -5,7 +5,7 @@ [![Build Status](https://travis-ci.org/thrasher-corp/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-corp/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-corp/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-corp/gocryptotrader/currency/forexprovider/fixer) +[![GoDoc](https://godoc.org/github.com/thrasher-corp/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-corp/gocryptotrader/currency/forexprovider/fixer.io) [![Coverage Status](http://codecov.io/github/thrasher-corp/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-corp/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-corp/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader) @@ -29,15 +29,15 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader + Individual package example below: ```go import ( -"github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" -"github.com/thrasher-corp/gocryptotrader/currency/forexprovider/fixer.io" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/fixer.io" ) c := fixer.Fixer{} // Define configuration newSettings := base.Settings{ - Name: "Fixer", + Name: "Fixer", Enabled: true, Verbose: false, RESTPollingDelay: time.Duration, @@ -72,4 +72,3 @@ When submitting a PR, please abide by our coding guidelines: 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/currency/forexprovider/openexchangerates/README.md b/currency/forexprovider/openexchangerates/README.md index a9724ed1..83f7fac3 100644 --- a/currency/forexprovider/openexchangerates/README.md +++ b/currency/forexprovider/openexchangerates/README.md @@ -29,15 +29,15 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader + Individual package example below: ```go import ( -"github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" -"github.com/thrasher-corp/gocryptotrader/currency/forexprovider/openexchangerates" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/base" + "github.com/thrasher-corp/gocryptotrader/currency/forexprovider/openexchangerates" ) c := openexchangerates.OXR{} // Define configuration newSettings := base.Settings{ - Name: "openexchangerates", + Name: "openexchangerates", Enabled: true, Verbose: false, RESTPollingDelay: time.Duration, @@ -72,4 +72,3 @@ When submitting a PR, please abide by our coding guidelines: 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/README.md b/exchanges/README.md index bbaf3ca1..9333cc6e 100644 --- a/exchanges/README.md +++ b/exchanges/README.md @@ -45,4 +45,3 @@ When submitting a PR, please abide by our coding guidelines: 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/alphapoint/README.md b/exchanges/alphapoint/README.md index dd75369b..99c6a8f7 100644 --- a/exchanges/alphapoint/README.md +++ b/exchanges/alphapoint/README.md @@ -46,4 +46,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index 43477a3c..1826110a 100644 --- a/exchanges/anx/README.md +++ b/exchanges/anx/README.md @@ -141,4 +141,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index d3cff5ab..11625cbd 100644 --- a/exchanges/binance/README.md +++ b/exchanges/binance/README.md @@ -138,4 +138,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index c7e03d5f..616cb503 100644 --- a/exchanges/bitfinex/README.md +++ b/exchanges/bitfinex/README.md @@ -138,4 +138,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index c666afd8..34a95fec 100644 --- a/exchanges/bitflyer/README.md +++ b/exchanges/bitflyer/README.md @@ -137,4 +137,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index 04fdc017..052e307e 100644 --- a/exchanges/bithumb/README.md +++ b/exchanges/bithumb/README.md @@ -130,4 +130,3 @@ When submitting a PR, please abide by our coding guidelines: 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/bitmex/README.md b/exchanges/bitmex/README.md index 0a78e42d..d77a9fed 100644 --- a/exchanges/bitmex/README.md +++ b/exchanges/bitmex/README.md @@ -130,4 +130,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index 9f2b4f2a..0acefd1f 100644 --- a/exchanges/bitstamp/README.md +++ b/exchanges/bitstamp/README.md @@ -138,4 +138,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index 6b1a0c63..039bc2e9 100644 --- a/exchanges/bittrex/README.md +++ b/exchanges/bittrex/README.md @@ -130,4 +130,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index 762de864..06a67665 100644 --- a/exchanges/btcmarkets/README.md +++ b/exchanges/btcmarkets/README.md @@ -23,6 +23,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ### Current Features + REST Support ++ Websocket Support ### How to enable @@ -130,4 +131,3 @@ When submitting a PR, please abide by our coding guidelines: 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/btse/README.md b/exchanges/btse/README.md index 5c5688e8..cdb5fd7e 100644 --- a/exchanges/btse/README.md +++ b/exchanges/btse/README.md @@ -1,30 +1,133 @@ - -# GoCryptoTrader Btse Exchange Wrapper +# GoCryptoTrader package Btse -An exchange interface wrapper for the GoCryptoTrader application. + +[![Build Status](https://travis-ci.org/thrasher-corp/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-corp/gocryptotrader) +[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE) +[![GoDoc](https://godoc.org/github.com/thrasher-corp/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-corp/gocryptotrader/exchanges/btse) +[![Coverage Status](http://codecov.io/github/thrasher-corp/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-corp/gocryptotrader?branch=master) +[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-corp/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader) + + +This btse 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). +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). -## Current Btse Exchange Features +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://join.slack.com/t/gocryptotrader/shared_invite/enQtNTQ5NDAxMjA2Mjc5LTc5ZDE1ZTNiOGM3ZGMyMmY1NTAxYWZhODE0MWM5N2JlZDk1NDU0YTViYzk4NTk3OTRiMDQzNGQ1YTc4YmRlMTk) -+ REST Support -+ Websocket Support +## BTCMarkets Exchange -+ Can be used as a package +### Current Features -## Notes ++ REST Support ++ Websocket Support -+ Please add notes here with any production issues -+ Please provide link to exchange website and API documentation +### How to enable -## Contributors ++ [Enable via configuration](https://github.com/thrasher-corp/gocryptotrader/tree/master/config#enable-exchange-via-config-example) -+ Please add your information ++ Individual package example below: -|User|Github|Contribution| -|--|--|--| -|AliasGoesHere|https://github.com/AliasGoesHere |WHAT-YOU-DID| +```go + // Exchanges will be abstracted out in further updates and examples will be + // supplied then +``` + +### How to do REST public/private calls + ++ If enabled via "configuration".json file the exchange will be added to the +IBotExchange array in the ```go var bot Bot``` and you will only be able to use +the wrapper interface functions for accessing exchange data. View routines.go +for an example of integration usage with GoCryptoTrader. Rudimentary example +below: + +main.go +```go +var b exchange.IBotExchange + +for i := range bot.Exchanges { + if bot.Exchanges[i].GetName() == "BTSE" { + b = bot.Exchanges[i] + } +} + +// Public calls - wrapper functions + +// Fetches current ticker information +tick, err := b.FetchTicker() +if err != nil { + // Handle error +} + +// Fetches current orderbook information +ob, err := b.FetchOrderbook() +if err != nil { + // Handle error +} + +// Private calls - wrapper functions - make sure your APIKEY and APISECRET are +// set and AuthenticatedAPISupport is set to true + +// Fetches current account information +accountInfo, err := b.GetAccountInfo() +if err != nil { + // Handle error +} +``` + ++ If enabled via individually importing package, rudimentary example below: + +```go +// Public calls + +// Fetches current ticker information +ticker, err := b.GetTicker() +if err != nil { + // Handle error +} + +// Fetches current orderbook information +ob, err := b.GetOrderBook() +if err != nil { + // Handle error +} + +// Private calls - make sure your APIKEY and APISECRET are set and +// AuthenticatedAPISupport is set to true + +// GetUserInfo returns account info +accountInfo, err := b.GetUserInfo(...) +if err != nil { + // Handle error +} + +// Submits an order and the exchange and returns its tradeID +tradeID, err := b.Trade(...) +if err != nil { + // Handle error +} +``` + +### 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-corp/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/coinbasepro/README.md b/exchanges/coinbasepro/README.md index d3df8fe8..b734dd6b 100644 --- a/exchanges/coinbasepro/README.md +++ b/exchanges/coinbasepro/README.md @@ -138,4 +138,3 @@ When submitting a PR, please abide by our coding guidelines: 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/coinbene/README.md b/exchanges/coinbene/README.md index e5a7cd7e..c4fe862f 100644 --- a/exchanges/coinbene/README.md +++ b/exchanges/coinbene/README.md @@ -90,7 +90,7 @@ if err != nil { } // Fetches current orderbook information -ob, err := c.GetOrderBook() +ob, err := c.GetOrderbook() if err != nil { // Handle error } @@ -105,7 +105,7 @@ if err != nil { } // Submits an order and the exchange and returns its tradeID -tradeID, err := c.Trade(...) +resp, err := c.SubmitOrder(...) if err != nil { // Handle error } @@ -138,4 +138,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index 1faf793f..dc2cc3ce 100644 --- a/exchanges/coinut/README.md +++ b/exchanges/coinut/README.md @@ -138,4 +138,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index 70fc25fa..64e212d8 100644 --- a/exchanges/exmo/README.md +++ b/exchanges/exmo/README.md @@ -130,4 +130,3 @@ When submitting a PR, please abide by our coding guidelines: 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/gateio/README.md b/exchanges/gateio/README.md index 98c5535e..f4e9763c 100644 --- a/exchanges/gateio/README.md +++ b/exchanges/gateio/README.md @@ -137,4 +137,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index 63bf7c14..7e528485 100644 --- a/exchanges/gemini/README.md +++ b/exchanges/gemini/README.md @@ -130,4 +130,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index 20bfa3a4..7acbaef6 100644 --- a/exchanges/hitbtc/README.md +++ b/exchanges/hitbtc/README.md @@ -138,4 +138,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index 3fad2d0f..6ef6ed77 100644 --- a/exchanges/huobi/README.md +++ b/exchanges/huobi/README.md @@ -137,4 +137,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index cb7a6d14..1c87aa4b 100644 --- a/exchanges/itbit/README.md +++ b/exchanges/itbit/README.md @@ -130,4 +130,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index 06609685..7992a499 100644 --- a/exchanges/kraken/README.md +++ b/exchanges/kraken/README.md @@ -130,4 +130,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index 0a0d1231..0a043476 100644 --- a/exchanges/lakebtc/README.md +++ b/exchanges/lakebtc/README.md @@ -131,4 +131,3 @@ When submitting a PR, please abide by our coding guidelines: 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/lbank/README.md b/exchanges/lbank/README.md index 78e67672..df025828 100644 --- a/exchanges/lbank/README.md +++ b/exchanges/lbank/README.md @@ -130,4 +130,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index 715e8c39..22123daa 100644 --- a/exchanges/localbitcoins/README.md +++ b/exchanges/localbitcoins/README.md @@ -130,4 +130,3 @@ When submitting a PR, please abide by our coding guidelines: 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 db4073fa..a30717dd 100644 --- a/exchanges/nonce/README.md +++ b/exchanges/nonce/README.md @@ -42,4 +42,3 @@ When submitting a PR, please abide by our coding guidelines: 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/okcoin/README.md b/exchanges/okcoin/README.md index 751cedee..578b12de 100644 --- a/exchanges/okcoin/README.md +++ b/exchanges/okcoin/README.md @@ -138,4 +138,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index 2b45d8de..5a6715db 100644 --- a/exchanges/okex/README.md +++ b/exchanges/okex/README.md @@ -130,4 +130,3 @@ When submitting a PR, please abide by our coding guidelines: 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 bd5c6ed4..e9befce8 100644 --- a/exchanges/orderbook/README.md +++ b/exchanges/orderbook/README.md @@ -73,4 +73,3 @@ When submitting a PR, please abide by our coding guidelines: 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/poloniex/README.md b/exchanges/poloniex/README.md index e9817e43..743045d7 100644 --- a/exchanges/poloniex/README.md +++ b/exchanges/poloniex/README.md @@ -138,4 +138,3 @@ When submitting a PR, please abide by our coding guidelines: 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/request/README.md b/exchanges/request/README.md index 37787934..fe20f726 100644 --- a/exchanges/request/README.md +++ b/exchanges/request/README.md @@ -43,4 +43,3 @@ When submitting a PR, please abide by our coding guidelines: 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 890b0930..f90c39e1 100644 --- a/exchanges/stats/README.md +++ b/exchanges/stats/README.md @@ -46,4 +46,3 @@ When submitting a PR, please abide by our coding guidelines: 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/ticker/README.md b/exchanges/ticker/README.md index 4dc3d5a3..f67a4c91 100644 --- a/exchanges/ticker/README.md +++ b/exchanges/ticker/README.md @@ -74,4 +74,3 @@ When submitting a PR, please abide by our coding guidelines: 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 index efada20d..fc89aca6 100644 --- a/exchanges/yobit/README.md +++ b/exchanges/yobit/README.md @@ -130,4 +130,3 @@ When submitting a PR, please abide by our coding guidelines: 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/zb/README.md b/exchanges/zb/README.md index 6fb94c2e..4d94cb06 100644 --- a/exchanges/zb/README.md +++ b/exchanges/zb/README.md @@ -137,4 +137,3 @@ When submitting a PR, please abide by our coding guidelines: 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 e9f77b9d..cf5b3579 100644 --- a/portfolio/README.md +++ b/portfolio/README.md @@ -42,4 +42,3 @@ When submitting a PR, please abide by our coding guidelines: 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/testdata/README.md b/testdata/README.md index 2f0aea4b..f3b7a360 100644 --- a/testdata/README.md +++ b/testdata/README.md @@ -41,5 +41,4 @@ When submitting a PR, please abide by our coding guidelines: If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: -***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** - +***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** \ No newline at end of file diff --git a/web/README.md b/web/README.md index 351ea81f..a4887b58 100644 --- a/web/README.md +++ b/web/README.md @@ -98,4 +98,3 @@ When submitting a PR, please abide by our coding guidelines: If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: ***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** -