Add directories to exclusion list && change default repo string (thra…

…sher-corp#387) * Add directories to exclusion list && change default repo string * Add in .idea folder to directory exclusion list * cleaned * Added support for calling the tool outside of its file * fix formatting * changed strings
KaneGZ · Nov 29, 2019 · 24bddcc · 24bddcc
1 parent d636882
commit 24bddcc
Show file tree

Hide file tree

Showing 65 changed files with 482 additions and 163 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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}}
diff --git 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
@@ -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,
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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*