From ef51adae76a8ecfff5dd803e467a73603e98ee38 Mon Sep 17 00:00:00 2001 From: Ryan O'Hara-Reid Date: Sun, 18 Feb 2018 11:09:36 +1100 Subject: [PATCH 1/4] Added new document tool for standardising supplementary documentation --- tools/documentation/documentation.go | 184 ++++++++++++++++++ .../readme_templates/common_readme.tmpl | 10 + .../readme_templates/config_readme.tmpl | 10 + .../currency_pair_readme.tmpl | 10 + .../readme_templates/currency_readme.tmpl | 10 + .../currency_symbol_readme.tmpl | 10 + .../currency_translation_readme.tmpl | 10 + .../readme_templates/events_readme.tmpl | 10 + .../exchanges_nonce_readme.tmpl | 10 + .../exchanges_orderbook_readme.tmpl | 10 + .../readme_templates/exchanges_readme.tmpl | 10 + .../exchanges_stats_readme.tmpl | 10 + .../exchanges_ticker_readme.tmpl | 10 + .../readme_templates/portfolio_readme.tmpl | 10 + .../readme_templates/root_readme.tmpl | 121 ++++++++++++ .../readme_templates/smsglobal_readme.tmpl | 10 + .../readme_templates/testdata_readme.tmpl | 10 + .../readme_templates/tools_readme.tmpl | 21 ++ .../readme_templates/web_readme.tmpl | 68 +++++++ .../sub_templates/contributions.tmpl | 12 ++ .../sub_templates/donations.tmpl | 9 + tools/documentation/sub_templates/header.tmpl | 15 ++ tools/documentation/sub_templates/status.tmpl | 7 + 23 files changed, 587 insertions(+) create mode 100644 tools/documentation/documentation.go create mode 100644 tools/documentation/readme_templates/common_readme.tmpl create mode 100644 tools/documentation/readme_templates/config_readme.tmpl create mode 100644 tools/documentation/readme_templates/currency_pair_readme.tmpl create mode 100644 tools/documentation/readme_templates/currency_readme.tmpl create mode 100644 tools/documentation/readme_templates/currency_symbol_readme.tmpl create mode 100644 tools/documentation/readme_templates/currency_translation_readme.tmpl create mode 100644 tools/documentation/readme_templates/events_readme.tmpl create mode 100644 tools/documentation/readme_templates/exchanges_nonce_readme.tmpl create mode 100644 tools/documentation/readme_templates/exchanges_orderbook_readme.tmpl create mode 100644 tools/documentation/readme_templates/exchanges_readme.tmpl create mode 100644 tools/documentation/readme_templates/exchanges_stats_readme.tmpl create mode 100644 tools/documentation/readme_templates/exchanges_ticker_readme.tmpl create mode 100644 tools/documentation/readme_templates/portfolio_readme.tmpl create mode 100644 tools/documentation/readme_templates/root_readme.tmpl create mode 100644 tools/documentation/readme_templates/smsglobal_readme.tmpl create mode 100644 tools/documentation/readme_templates/testdata_readme.tmpl create mode 100644 tools/documentation/readme_templates/tools_readme.tmpl create mode 100644 tools/documentation/readme_templates/web_readme.tmpl create mode 100644 tools/documentation/sub_templates/contributions.tmpl create mode 100644 tools/documentation/sub_templates/donations.tmpl create mode 100644 tools/documentation/sub_templates/header.tmpl create mode 100644 tools/documentation/sub_templates/status.tmpl diff --git a/tools/documentation/documentation.go b/tools/documentation/documentation.go new file mode 100644 index 00000000000..ca034771359 --- /dev/null +++ b/tools/documentation/documentation.go @@ -0,0 +1,184 @@ +package main + +import ( + "flag" + "fmt" + "html/template" + "log" + "os" + + "github.com/thrasher-/gocryptotrader/common" +) + +const ( + commonPath = "..%s..%scommon%s" + configPath = "..%s..%sconfig%s" + currencyPath = "..%s..%scurrency%s" + currencyPairPath = "..%s..%scurrency%spair%s" + currencySymbolPath = "..%s..%scurrency%ssymbol%s" + currencyTranslationPath = "..%s..%scurrency%stranslation%s" + eventsPath = "..%s..%sevents%s" + exchangesPath = "..%s..%sexchanges%s" + exchangesNoncePath = "..%s..%sexchanges%snonce%s" + exchangesOrderbookPath = "..%s..%sexchanges%sorderbook%s" + exchangesStatsPath = "..%s..%sexchanges%sstats%s" + exchangesTickerPath = "..%s..%sexchanges%sticker%s" + portfolioPath = "..%s..%sportfolio%s" + smsglobalPath = "..%s..%ssmsglobal%s" + testdataPath = "..%s..%stestdata%s" + toolsPath = "..%s..%stools%s" + webPath = "..%s..%sweb%s" + rootPath = "..%s..%s" +) + +var ( + verbose, replace bool + codebasePaths map[string]string + codebaseTemplatePath map[string]string + codebaseReadme map[string]readme + tmpl *template.Template + path string +) + +type readme struct { + Name string + Contributors string +} + +func main() { + + flag.BoolVar(&verbose, "v", false, "-v Verbose flag prints more information to the std output") + flag.BoolVar(&replace, "r", false, "-r Replace flag generates and replaces all documentation across the code base") + + flag.Parse() + + fmt.Println(` + GoCryptoTrader: Exchange documentation tool + + This will update and regenerate documentation for the different packages + in GoCryptoTrader. +`) + + codebasePaths = make(map[string]string) + codebaseTemplatePath = make(map[string]string) + codebaseReadme = make(map[string]readme) + path = common.GetOSPathSlash() + if err := addTemplates(); err != nil { + log.Fatal("GoCryptoTrader: Exchange documentation tool add template error ", err) + } + + if err := updateReadme(); err != nil { + log.Fatal("GoCryptoTrader: Exchange documentation tool update readme error ", err) + } + + fmt.Println("\nTool finished") +} + +// Iterates through codebase paths to check for readme files and either adds +// or replaces with new readme files. +func updateReadme() error { + addPaths() + + for packageName := range codebasePaths { + addReadmeData(packageName) + + if !checkReadme(packageName) { + if verbose { + fmt.Printf("* %s Readme file FOUND.\n", packageName) + } + if replace { + fmt.Println("file replacement") + if err := replaceReadme(packageName); err != nil { + return err + } + continue + } + continue + } + if verbose { + fmt.Printf("* %s Readme file NOT FOUND.\n", packageName) + } + if replace { + log.Println("file creation") + if err := createReadme(packageName); err != nil { + return err + } + continue + } + } + return nil +} + +// Adds paths to different potential README.md files in the codebase +func addPaths() { + codebasePaths["common"] = fmt.Sprintf(commonPath, path, path, path) + codebasePaths["config"] = fmt.Sprintf(configPath, path, path, path) + codebasePaths["currency"] = fmt.Sprintf(currencyPath, path, path, path) + codebasePaths["currency pair"] = fmt.Sprintf(currencyPairPath, path, path, path, path) + codebasePaths["currency symbol"] = fmt.Sprintf(currencySymbolPath, path, path, path, path) + codebasePaths["currency translation"] = fmt.Sprintf(currencyTranslationPath, path, path, path, path) + codebasePaths["events"] = fmt.Sprintf(eventsPath, path, path, path) + codebasePaths["exchanges"] = fmt.Sprintf(exchangesPath, path, path, path) + codebasePaths["exchanges nonce"] = fmt.Sprintf(exchangesNoncePath, path, path, path, path) + codebasePaths["exchanges orderbook"] = fmt.Sprintf(exchangesOrderbookPath, path, path, path, path) + codebasePaths["exchanges stats"] = fmt.Sprintf(exchangesStatsPath, path, path, path, path) + codebasePaths["exchanges ticker"] = fmt.Sprintf(exchangesTickerPath, path, path, path, path) + codebasePaths["portfolio"] = fmt.Sprintf(portfolioPath, path, path, path) + codebasePaths["smsglobal"] = fmt.Sprintf(smsglobalPath, path, path, path) + codebasePaths["testdata"] = fmt.Sprintf(testdataPath, path, path, path) + codebasePaths["tools"] = fmt.Sprintf(toolsPath, path, path, path) + codebasePaths["web"] = fmt.Sprintf(webPath, path, path, path) + codebasePaths["root"] = fmt.Sprintf(rootPath, path, path) +} + +func addReadmeData(packageName string) { + readmeInfo := readme{ + Name: packageName, + Contributors: "", //future implementation to track contributors + } + codebaseReadme[packageName] = readmeInfo +} + +// adds all the template files +func addTemplates() error { + glob, err := template.ParseGlob(fmt.Sprintf("readme_templates%s*", path)) + if err != nil { + return err + } + _, err = glob.ParseGlob(fmt.Sprintf("sub_templates%s*", path)) + if err != nil { + return err + } + + tmpl = glob + return nil +} + +// checkReadme checks to see if the file exists +func checkReadme(packageName string) bool { + _, err := os.Stat(codebasePaths[packageName] + "README.md") + return os.IsNotExist(err) +} + +// replaces readme file +func replaceReadme(packageName string) error { + if err := deleteFile(codebasePaths[packageName] + "README.md"); err != nil { + return err + } + return createReadme(packageName) +} + +// creates new readme file and executes template +func createReadme(packageName string) error { + file, err := os.Create(codebasePaths[packageName] + "README.md") + defer file.Close() + if err != nil { + return err + } + fmt.Println("File done") + return tmpl.ExecuteTemplate(file, packageName, codebaseReadme[packageName]) +} + +func deleteFile(path string) error { + return os.Remove(path) +} diff --git a/tools/documentation/readme_templates/common_readme.tmpl b/tools/documentation/readme_templates/common_readme.tmpl new file mode 100644 index 00000000000..ace0be94139 --- /dev/null +++ b/tools/documentation/readme_templates/common_readme.tmpl @@ -0,0 +1,10 @@ +{{define "common" -}} +{{template "header" .Name}} +## Current Features for {{.Name}} + ++ This package collates basic broad functions that are used throughout this codebase + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/readme_templates/config_readme.tmpl b/tools/documentation/readme_templates/config_readme.tmpl new file mode 100644 index 00000000000..1e74ce84a8b --- /dev/null +++ b/tools/documentation/readme_templates/config_readme.tmpl @@ -0,0 +1,10 @@ +{{define "config" -}} +{{template "header" .Name}} +## Current Features for {{.Name}} + ++ This package deals with configuration utilities + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/readme_templates/currency_pair_readme.tmpl b/tools/documentation/readme_templates/currency_pair_readme.tmpl new file mode 100644 index 00000000000..92b9ff2f8f7 --- /dev/null +++ b/tools/documentation/readme_templates/currency_pair_readme.tmpl @@ -0,0 +1,10 @@ +{{define "currency pair" -}} +{{template "header" .Name}} +## Current Features for {{.Name}} + ++ This package services the currency package + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/readme_templates/currency_readme.tmpl b/tools/documentation/readme_templates/currency_readme.tmpl new file mode 100644 index 00000000000..fb1b1242a09 --- /dev/null +++ b/tools/documentation/readme_templates/currency_readme.tmpl @@ -0,0 +1,10 @@ +{{define "currency" -}} +{{template "header" .Name}} +## Current Features for {{.Name}} + ++ Currency package deals with currency pair generation, manipulation and tracking + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/readme_templates/currency_symbol_readme.tmpl b/tools/documentation/readme_templates/currency_symbol_readme.tmpl new file mode 100644 index 00000000000..d020ac0b002 --- /dev/null +++ b/tools/documentation/readme_templates/currency_symbol_readme.tmpl @@ -0,0 +1,10 @@ +{{define "currency symbol" -}} +{{template "header" .Name}} +## Current Features for {{.Name}} + ++ This package services the currency package + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/readme_templates/currency_translation_readme.tmpl b/tools/documentation/readme_templates/currency_translation_readme.tmpl new file mode 100644 index 00000000000..e127a46e804 --- /dev/null +++ b/tools/documentation/readme_templates/currency_translation_readme.tmpl @@ -0,0 +1,10 @@ +{{define "currency translation" -}} +{{template "header" .Name}} +## Current Features for {{.Name}} + ++ This package services the currency package with translation functions + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/readme_templates/events_readme.tmpl b/tools/documentation/readme_templates/events_readme.tmpl new file mode 100644 index 00000000000..d61fa9e63ed --- /dev/null +++ b/tools/documentation/readme_templates/events_readme.tmpl @@ -0,0 +1,10 @@ +{{define "events" -}} +{{template "header" .Name}} +## Current Features for {{.Name}} + ++ The events package handles events from GoCryptoTrader bot + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/readme_templates/exchanges_nonce_readme.tmpl b/tools/documentation/readme_templates/exchanges_nonce_readme.tmpl new file mode 100644 index 00000000000..e5ce29625dc --- /dev/null +++ b/tools/documentation/readme_templates/exchanges_nonce_readme.tmpl @@ -0,0 +1,10 @@ +{{define "exchanges nonce" -}} +{{template "header" .Name}} +## Current Features for {{.Name}} + ++ This package services the exchanges package with nonce creation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/readme_templates/exchanges_orderbook_readme.tmpl b/tools/documentation/readme_templates/exchanges_orderbook_readme.tmpl new file mode 100644 index 00000000000..9afb871d4a1 --- /dev/null +++ b/tools/documentation/readme_templates/exchanges_orderbook_readme.tmpl @@ -0,0 +1,10 @@ +{{define "exchanges orderbook" -}} +{{template "header" .Name}} +## Current Features for {{.Name}} + ++ This package facilitates orderbook generation + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/readme_templates/exchanges_readme.tmpl b/tools/documentation/readme_templates/exchanges_readme.tmpl new file mode 100644 index 00000000000..0f8b6b35763 --- /dev/null +++ b/tools/documentation/readme_templates/exchanges_readme.tmpl @@ -0,0 +1,10 @@ +{{define "exchanges" -}} +{{template "header" .Name}} +## Current Features for {{.Name}} + ++ This package is used to connect and query data from supported exchanges + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/readme_templates/exchanges_stats_readme.tmpl b/tools/documentation/readme_templates/exchanges_stats_readme.tmpl new file mode 100644 index 00000000000..dacf0cba1c7 --- /dev/null +++ b/tools/documentation/readme_templates/exchanges_stats_readme.tmpl @@ -0,0 +1,10 @@ +{{define "exchanges stats" -}} +{{template "header" .Name}} +## Current Features for {{.Name}} + ++ This package services the exchanges package + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/readme_templates/exchanges_ticker_readme.tmpl b/tools/documentation/readme_templates/exchanges_ticker_readme.tmpl new file mode 100644 index 00000000000..35f3d031f91 --- /dev/null +++ b/tools/documentation/readme_templates/exchanges_ticker_readme.tmpl @@ -0,0 +1,10 @@ +{{define "exchanges ticker" -}} +{{template "header" .Name}} +## Current Features for {{.Name}} + ++ This services the exchanges package by ticker functions + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/readme_templates/portfolio_readme.tmpl b/tools/documentation/readme_templates/portfolio_readme.tmpl new file mode 100644 index 00000000000..68ced8876c4 --- /dev/null +++ b/tools/documentation/readme_templates/portfolio_readme.tmpl @@ -0,0 +1,10 @@ +{{define "portfolio" -}} +{{template "header" .Name}} +## Current Features for {{.Name}} + ++ This package allows for the monitoring of portfolio data + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/readme_templates/root_readme.tmpl b/tools/documentation/readme_templates/root_readme.tmpl new file mode 100644 index 00000000000..11ce4ab8776 --- /dev/null +++ b/tools/documentation/readme_templates/root_readme.tmpl @@ -0,0 +1,121 @@ +{{define "root" -}} + + +[![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) +[![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) + +A cryptocurrency trading bot supporting multiple exchanges written in Golang. + +**Please note that this bot is under development and is not ready for production!** + +## Community + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) + +## Exchange Support Table + +| Exchange | REST API | Streaming API | FIX API | +|----------|------|-----------|-----| +| Alphapoint | Yes | Yes | NA | +| ANXPRO | Yes | No | NA | +| Binance| Yes | No | NA | +| Bitfinex | Yes | Yes | NA | +| Bitflyer | Yes | No | NA | +| Bithumb | Yes | NA | NA | +| Bitstamp | Yes | Yes | No | +| Bittrex | Yes | No | NA | +| BTCC | Yes | Yes | No | +| BTCMarkets | Yes | No | NA | +| COINUT | Yes | No | NA | +| Exmo | Yes | NA | NA | +| GDAX(Coinbase) | Yes | Yes | No| +| Gemini | Yes | No | No | +| HitBTC | Yes | Yes | No | +| Huobi.Pro | Yes | No |No | +| ItBit | Yes | NA | No | +| Kraken | Yes | NA | NA | +| LakeBTC | Yes | No | NA | +| Liqui | Yes | No | NA | +| LocalBitcoins | Yes | NA | NA | +| OKCoin China | Yes | Yes | No | +| OKCoin International | Yes | Yes | No | +| OKEX | Yes | No | No | +| Poloniex | Yes | Yes | NA | +| WEX | Yes | NA | NA | +| Yobit | Yes | NA | NA | + +We are aiming to support the top 20 highest volume exchanges based off the [CoinMarketCap exchange data](https://coinmarketcap.com/exchanges/volume/24-hour/). + +** NA means not applicable as the Exchange does not support the feature. + +## Current Features + ++ Support for all Exchange fiat and digital currencies, with the ability to individually toggle them on/off. ++ AES encrypted config file. ++ REST API support for all exchanges. ++ Websocket support for applicable exchanges. ++ Ability to turn off/on certain exchanges. ++ Ability to adjust manual polling timer for exchanges. ++ SMS notification support via SMS Gateway. ++ Packages for handling currency pairs, ticker/orderbook fetching and currency conversion. ++ Portfolio management tool; fetches balances from supported exchanges and allows for custom address tracking. ++ Basic event trigger system. ++ WebGUI. + +## Planned Features + +Planned features can be found on our [community Trello page](https://trello.com/b/ZAhMhpOy/gocryptotrader). + +## 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. + +## Compiling instructions + +Download and install Go from [Go Downloads](https://golang.org/dl/) for your +platform. + +### Linux/OSX + +```bash +go get github.com/thrasher-/gocryptotrader +cd $GOPATH/src/github.com/thrasher-/gocryptotrader +make get +make install +cp $GOPATH/src/github.com/thrasher-/gocryptotrader/config_example.json $GOPATH/bin/config.json +``` + +### Windows + +```bash +go get github.com/thrasher-/gocryptotrader +cd %GOPATH%\src\github.com\thrasher-\gocryptotrader +go install +copy %GOPATH%\src\github.com\thrasher-\gocryptotrader\config_example.json %GOPATH%\bin\config.json +``` + ++ Make any neccessary changes to the `config.json` file. ++ Run the `gocryptotrader` binary file inside your GOPATH bin folder. + +## 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*** + +## Binaries + +Binaries will be published once the codebase reaches a stable condition. +{{end}} diff --git a/tools/documentation/readme_templates/smsglobal_readme.tmpl b/tools/documentation/readme_templates/smsglobal_readme.tmpl new file mode 100644 index 00000000000..98d025c7997 --- /dev/null +++ b/tools/documentation/readme_templates/smsglobal_readme.tmpl @@ -0,0 +1,10 @@ +{{define "smsglobal" -}} +{{template "header" .Name}} +## Current Features for {{.Name}} + ++ This package allows for the messaging of events to a personal phone number or a group of phone numbers + +### Please click GoDocs chevron above to view current GoDoc information for this package +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/readme_templates/testdata_readme.tmpl b/tools/documentation/readme_templates/testdata_readme.tmpl new file mode 100644 index 00000000000..30b42453a7b --- /dev/null +++ b/tools/documentation/readme_templates/testdata_readme.tmpl @@ -0,0 +1,10 @@ +{{define "testdata" -}} +{{template "header" .Name}} +## Current Features + +This folder contains a configuration test file for non-deployement test params. +It also has the code coverage test files that allow us to monitor our entire +codebase, click this link for more information [https://codecov.io/](https://codecov.io/). +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/readme_templates/tools_readme.tmpl b/tools/documentation/readme_templates/tools_readme.tmpl new file mode 100644 index 00000000000..f447eaff666 --- /dev/null +++ b/tools/documentation/readme_templates/tools_readme.tmpl @@ -0,0 +1,21 @@ +{{define "tools" -}} +{{template "header" .Name}} +## Current Features + +This folder contains an assortment of tools + ++ Configuration ++ Documentation creation ++ Portfolio monitoring ++ Exchange deployment ++ Websocket client + + +Example Run for documentation generation - flags -v Verbose & -R Replace files +``` +cd documentation/ +go run documentation -v +``` +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/readme_templates/web_readme.tmpl b/tools/documentation/readme_templates/web_readme.tmpl new file mode 100644 index 00000000000..be927649ba3 --- /dev/null +++ b/tools/documentation/readme_templates/web_readme.tmpl @@ -0,0 +1,68 @@ +{{define "web" -}} +{{template "header" .Name}} +## Current Features + + ++ It can run ++ It can be compiled with Electron to run as an executable ++ Websocket support to listen to GoCryptoTrader events ++ Material design ++ Has a semi-working Settings page ++ Has a basic ticker dashboard + +## Install dependencies with npm + +``` bash +npm install +``` + +If you want to generate Angular components with Angular-cli , you **MUST** install `@angular/cli` in npm global context. +Please follow [Angular-cli documentation](https://github.com/angular/angular-cli) if you had installed a previous version of `angular-cli`. + +``` bash +npm install -g @angular/cli +``` + +## To build for development + +``` bash +npm run start:web +``` + +Voila! You can use GoCryptoTrader web app in a local development environment with webpack watching! + +## To build for production + ++ Using development variables (environments/index.ts) : `npm run electron:dev` ++ Using production variables (environments/index.prod.ts) : `npm run electron:prod` + +Your built files are in the /dist folder. + +## Included Commands + +|Command|Description| +|--|--| +|`npm run start:web`| Execute the app in the brower | +|`npm run electron:linux`| Builds your application and creates an app consumable on linux system | +|`npm run electron:windows`| On a Windows OS, builds your application and creates an app consumable in windows 32/64 bit systems | +|`npm run electron:mac`| On a MAC OS, builds your application and generates a `.app` file of your application that can be run on Ma | + +## Execute E2E tests + +You can find end-to-end tests in /e2e folder. + +You can run tests with the command lines below: + ++ **in a terminal window** -> First, start a web server on port 4200 : `npm run start:web` ++ **in another terminal window** -> Then, launch Protractor (E2E framework): `npm run e2e` + +## Contributors + +|User|Github|Contribution| +|--|--|--| +|GloriousCode|https://github.com/gloriouscode |Lead front-end| +|Maxime GRIS|https://github.com/maximegris |Angular4 + Electron Base| +|Shazbert|https://github.com/shazbert |Initial designs| +{{template "contributions"}} +{{template "donations"}} +{{end}} diff --git a/tools/documentation/sub_templates/contributions.tmpl b/tools/documentation/sub_templates/contributions.tmpl new file mode 100644 index 00000000000..51b4e9bf009 --- /dev/null +++ b/tools/documentation/sub_templates/contributions.tmpl @@ -0,0 +1,12 @@ +{{define "contributions"}} +## 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. +{{end}} diff --git a/tools/documentation/sub_templates/donations.tmpl b/tools/documentation/sub_templates/donations.tmpl new file mode 100644 index 00000000000..5c53ef65958 --- /dev/null +++ b/tools/documentation/sub_templates/donations.tmpl @@ -0,0 +1,9 @@ +{{define "donations" -}} +## 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*** +{{end}} diff --git a/tools/documentation/sub_templates/header.tmpl b/tools/documentation/sub_templates/header.tmpl new file mode 100644 index 00000000000..5e2ea1a3305 --- /dev/null +++ b/tools/documentation/sub_templates/header.tmpl @@ -0,0 +1,15 @@ +{{define "header" -}} +# GoCryptoTrader package {{.}} + + + +{{template "status" .}} + +This {{.}} 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/) +{{end}} diff --git a/tools/documentation/sub_templates/status.tmpl b/tools/documentation/sub_templates/status.tmpl new file mode 100644 index 00000000000..71de2a8461d --- /dev/null +++ b/tools/documentation/sub_templates/status.tmpl @@ -0,0 +1,7 @@ +{{define "status"}} +[![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) +[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/{{.}}) +[![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) +[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) +{{end}} From 6cb17bb97e4e2f7718254bc13ce670bc5e34066b Mon Sep 17 00:00:00 2001 From: Ryan O'Hara-Reid Date: Sun, 18 Feb 2018 11:12:06 +1100 Subject: [PATCH 2/4] Added new base documentation using documentation tool --- common/README.md | 45 +++++++++++++++++++++++++++ config/README.md | 45 +++++++++++++++++++++++++++ currency/README.md | 45 +++++++++++++++++++++++++++ currency/pair/README.md | 45 +++++++++++++++++++++++++++ currency/symbol/README.md | 45 +++++++++++++++++++++++++++ currency/translation/README.md | 45 +++++++++++++++++++++++++++ events/README.md | 45 +++++++++++++++++++++++++++ exchanges/README.md | 45 +++++++++++++++++++++++++++ exchanges/nonce/README.md | 45 +++++++++++++++++++++++++++ exchanges/orderbook/README.md | 45 +++++++++++++++++++++++++++ exchanges/stats/README.md | 45 +++++++++++++++++++++++++++ exchanges/ticker/README.md | 45 +++++++++++++++++++++++++++ portfolio/README.md | 45 +++++++++++++++++++++++++++ smsglobal/README.md | 45 +++++++++++++++++++++++++++ testdata/README.md | 45 +++++++++++++++++++++++++++ tools/README.md | 56 ++++++++++++++++++++++++++++++++++ web/README.md | 39 ++++++++++++++++++++--- 17 files changed, 766 insertions(+), 4 deletions(-) create mode 100644 common/README.md create mode 100644 config/README.md create mode 100644 currency/README.md create mode 100644 currency/pair/README.md create mode 100644 currency/symbol/README.md create mode 100644 currency/translation/README.md create mode 100644 events/README.md create mode 100644 exchanges/README.md create mode 100644 exchanges/nonce/README.md create mode 100644 exchanges/orderbook/README.md create mode 100644 exchanges/stats/README.md create mode 100644 exchanges/ticker/README.md create mode 100644 portfolio/README.md create mode 100644 smsglobal/README.md create mode 100644 testdata/README.md create mode 100644 tools/README.md diff --git a/common/README.md b/common/README.md new file mode 100644 index 00000000000..2619184792a --- /dev/null +++ b/common/README.md @@ -0,0 +1,45 @@ +# GoCryptoTrader package common + + + + +[![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/common) +[![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 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 + + + +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 new file mode 100644 index 00000000000..a03e34b5315 --- /dev/null +++ b/config/README.md @@ -0,0 +1,45 @@ +# GoCryptoTrader package config + + + + +[![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/config) +[![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 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 + + + +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 new file mode 100644 index 00000000000..18be21e396c --- /dev/null +++ b/currency/README.md @@ -0,0 +1,45 @@ +# GoCryptoTrader package currency + + + + +[![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) +[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/currency) +[![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) +[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) + + +This currency 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 + + + +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/pair/README.md b/currency/pair/README.md new file mode 100644 index 00000000000..0e620800dd7 --- /dev/null +++ b/currency/pair/README.md @@ -0,0 +1,45 @@ +# GoCryptoTrader package currency pair + + + + +[![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) +[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/currency pair) +[![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) +[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) + + +This currency pair package is part of the GoCryptoTrader codebase + +## This 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 + + + +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/symbol/README.md b/currency/symbol/README.md new file mode 100644 index 00000000000..37807fe3cc7 --- /dev/null +++ b/currency/symbol/README.md @@ -0,0 +1,45 @@ +# GoCryptoTrader package currency symbol + + + + +[![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) +[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/currency symbol) +[![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) +[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) + + +This currency symbol package is part of the GoCryptoTrader codebase + +## This 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 + + + +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/translation/README.md b/currency/translation/README.md new file mode 100644 index 00000000000..e1499fd9716 --- /dev/null +++ b/currency/translation/README.md @@ -0,0 +1,45 @@ +# GoCryptoTrader package currency translation + + + + +[![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) +[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/currency translation) +[![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) +[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) + + +This currency translation package is part of the GoCryptoTrader codebase + +## This 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 + + + +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/events/README.md b/events/README.md new file mode 100644 index 00000000000..3ce3298cc70 --- /dev/null +++ b/events/README.md @@ -0,0 +1,45 @@ +# GoCryptoTrader package events + + + + +[![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/events) +[![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 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 + + + +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 new file mode 100644 index 00000000000..1f2377b6c60 --- /dev/null +++ b/exchanges/README.md @@ -0,0 +1,45 @@ +# GoCryptoTrader package exchanges + + + + +[![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) +[![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) +[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) + + +This exchanges 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 exchanges + ++ This package is used to connect and query data from supported exchanges + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## 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 new file mode 100644 index 00000000000..c53e9666257 --- /dev/null +++ b/exchanges/nonce/README.md @@ -0,0 +1,45 @@ +# GoCryptoTrader package exchanges nonce + + + + +[![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) +[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges nonce) +[![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) +[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) + + +This exchanges nonce package is part of the GoCryptoTrader codebase + +## This 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 exchanges nonce + ++ This package services the exchanges package with nonce creation + +### 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 new file mode 100644 index 00000000000..565b6ab930c --- /dev/null +++ b/exchanges/orderbook/README.md @@ -0,0 +1,45 @@ +# GoCryptoTrader package exchanges orderbook + + + + +[![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) +[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges orderbook) +[![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) +[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) + + +This exchanges orderbook package is part of the GoCryptoTrader codebase + +## This 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 exchanges orderbook + ++ This package facilitates orderbook 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 new file mode 100644 index 00000000000..3c332aea01d --- /dev/null +++ b/exchanges/stats/README.md @@ -0,0 +1,45 @@ +# GoCryptoTrader package exchanges stats + + + + +[![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) +[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges stats) +[![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) +[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) + + +This exchanges stats package is part of the GoCryptoTrader codebase + +## This 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 exchanges stats + ++ This package services the exchanges 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 + + + +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 new file mode 100644 index 00000000000..eacba5f2c82 --- /dev/null +++ b/exchanges/ticker/README.md @@ -0,0 +1,45 @@ +# GoCryptoTrader package exchanges ticker + + + + +[![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) +[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges ticker) +[![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) +[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) + + +This exchanges ticker package is part of the GoCryptoTrader codebase + +## This 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 exchanges ticker + ++ This services the exchanges package by ticker 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 + + + +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 new file mode 100644 index 00000000000..e1edbbac1c3 --- /dev/null +++ b/portfolio/README.md @@ -0,0 +1,45 @@ +# GoCryptoTrader package portfolio + + + + +[![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/portfolio) +[![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 portfolio 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 portfolio + ++ This package allows for the monitoring of portfolio data + +### 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/smsglobal/README.md b/smsglobal/README.md new file mode 100644 index 00000000000..17ce3d082ab --- /dev/null +++ b/smsglobal/README.md @@ -0,0 +1,45 @@ +# GoCryptoTrader package smsglobal + + + + +[![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/smsglobal) +[![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 smsglobal 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 smsglobal + ++ This package allows for the messaging of events to a personal phone number or a group of phone numbers + +### Please click GoDocs chevron above to view current GoDoc information for this package + +## 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/testdata/README.md b/testdata/README.md new file mode 100644 index 00000000000..85f332e0c2b --- /dev/null +++ b/testdata/README.md @@ -0,0 +1,45 @@ +# 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/testdata) +[![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) +[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) + + +This testdata package is part of the GoCryptoTrader codebase + +## This 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 + +This folder contains a configuration test file for non-deployement test params. +It also has the code coverage test files that allow us to monitor our entire +codebase, click this link for more information [https://codecov.io/](https://codecov.io/). + +## 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/tools/README.md b/tools/README.md new file mode 100644 index 00000000000..77376b8653d --- /dev/null +++ b/tools/README.md @@ -0,0 +1,56 @@ +# 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/tools) +[![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) +[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) + + +This tools package is part of the GoCryptoTrader codebase + +## This 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 + +This folder contains an assortment of tools + ++ Configuration ++ Documentation creation ++ Portfolio monitoring ++ Exchange deployment ++ Websocket client + + +Example Run for documentation generation - flags -v Verbose & -R Replace files +``` +cd documentation/ +go run documentation -v +``` + +## 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/web/README.md b/web/README.md index 5d02a2d08bc..61d01df4140 100644 --- a/web/README.md +++ b/web/README.md @@ -1,15 +1,26 @@ -# GoCryptoTrader Website +# GoCryptoTrader package web -A website interface to interact with the main GoCryptoTrader application. It is developed with Angular 4 with support for Electron + +[![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/web) +[![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 web 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). + +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) ## Current Features + + It can run + It can be compiled with Electron to run as an executable + Websocket support to listen to GoCryptoTrader events @@ -69,4 +80,24 @@ You can run tests with the command lines below: |--|--|--| |GloriousCode|https://github.com/gloriouscode |Lead front-end| |Maxime GRIS|https://github.com/maximegris |Angular4 + Electron Base| -|Shazbert|https://github.com/shazbert |Initial designs| \ No newline at end of file +|Shazbert|https://github.com/shazbert |Initial designs| + +## 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*** + From 51755d214b0a696476d4df8a30ef73570aa6a992 Mon Sep 17 00:00:00 2001 From: Ryan O'Hara-Reid Date: Sun, 18 Feb 2018 19:40:22 +1100 Subject: [PATCH 3/4] Added contributor generation function. Applied updates to README docs. --- README.md | 27 +++++++++++++++ tools/documentation/documentation.go | 34 ++++++++++++++++--- .../readme_templates/root_readme.tmpl | 1 + .../sub_templates/contributors.tmpl | 10 ++++++ 4 files changed, 67 insertions(+), 5 deletions(-) create mode 100644 tools/documentation/sub_templates/contributors.tmpl diff --git a/README.md b/README.md index 586633ea405..6d56dfe2061 100644 --- a/README.md +++ b/README.md @@ -135,3 +135,30 @@ If this framework helped you in any way, or you would like to support the develo ## Binaries Binaries will be published once the codebase reaches a stable condition. + +## Contributor List + +|User|Github|Contribution Amount| +|--|--|--| +| thrasher- | https://api.github.com/users/thrasher- | 411 | +| gloriousCode | https://api.github.com/users/gloriousCode | 113 | +| shazbert | https://api.github.com/users/shazbert | 108 | +| 140am | https://api.github.com/users/140am | 8 | +| faddat | https://api.github.com/users/faddat | 4 | +| crackcomm | https://api.github.com/users/crackcomm | 3 | +| bretep | https://api.github.com/users/bretep | 2 | +| gam-phon | https://api.github.com/users/gam-phon | 2 | +| cornelk | https://api.github.com/users/cornelk | 2 | +| if1live | https://api.github.com/users/if1live | 2 | +| daniel-cohen | https://api.github.com/users/daniel-cohen | 1 | +| starit | https://api.github.com/users/starit | 1 | +| mattkanwisher | https://api.github.com/users/mattkanwisher | 1 | +| mKurrels | https://api.github.com/users/mKurrels | 1 | +| m1kola | https://api.github.com/users/m1kola | 1 | +| tongxiaofeng | https://api.github.com/users/tongxiaofeng | 1 | +| idealhack | https://api.github.com/users/idealhack | 1 | +| askew- | https://api.github.com/users/askew- | 1 | +| snipesjr | https://api.github.com/users/snipesjr | 1 | + + + diff --git a/tools/documentation/documentation.go b/tools/documentation/documentation.go index ca034771359..6c56621eab0 100644 --- a/tools/documentation/documentation.go +++ b/tools/documentation/documentation.go @@ -29,6 +29,8 @@ const ( toolsPath = "..%s..%stools%s" webPath = "..%s..%sweb%s" rootPath = "..%s..%s" + + contributorsList = "https://api.github.com/repos/thrasher-/gocryptotrader/contributors" ) var ( @@ -38,11 +40,18 @@ var ( codebaseReadme map[string]readme tmpl *template.Template path string + contributors []contributor ) type readme struct { Name string - Contributors string + Contributors []contributor +} + +type contributor struct { + Login string `json:"login"` + URL string `json:"url"` + Contributions int `json:"contributions"` } func main() { @@ -63,6 +72,11 @@ func main() { codebaseTemplatePath = make(map[string]string) codebaseReadme = make(map[string]readme) path = common.GetOSPathSlash() + + if err := getContributorList(); err != nil { + log.Fatal("GoCryptoTrader: Exchange documentation tool GET error ", err) + } + if err := addTemplates(); err != nil { log.Fatal("GoCryptoTrader: Exchange documentation tool add template error ", err) } @@ -87,7 +101,9 @@ func updateReadme() error { fmt.Printf("* %s Readme file FOUND.\n", packageName) } if replace { - fmt.Println("file replacement") + if verbose { + fmt.Println("file replacement") + } if err := replaceReadme(packageName); err != nil { return err } @@ -99,7 +115,9 @@ func updateReadme() error { fmt.Printf("* %s Readme file NOT FOUND.\n", packageName) } if replace { - log.Println("file creation") + if verbose { + log.Println("file creation") + } if err := createReadme(packageName); err != nil { return err } @@ -134,7 +152,7 @@ func addPaths() { func addReadmeData(packageName string) { readmeInfo := readme{ Name: packageName, - Contributors: "", //future implementation to track contributors + Contributors: contributors, } codebaseReadme[packageName] = readmeInfo } @@ -175,10 +193,16 @@ func createReadme(packageName string) error { if err != nil { return err } - fmt.Println("File done") + if verbose { + fmt.Println("File done") + } return tmpl.ExecuteTemplate(file, packageName, codebaseReadme[packageName]) } func deleteFile(path string) error { return os.Remove(path) } + +func getContributorList() error { + return common.SendHTTPGetRequest(contributorsList, true, false, &contributors) +} diff --git a/tools/documentation/readme_templates/root_readme.tmpl b/tools/documentation/readme_templates/root_readme.tmpl index 11ce4ab8776..d12ca03c42b 100644 --- a/tools/documentation/readme_templates/root_readme.tmpl +++ b/tools/documentation/readme_templates/root_readme.tmpl @@ -118,4 +118,5 @@ If this framework helped you in any way, or you would like to support the develo ## Binaries Binaries will be published once the codebase reaches a stable condition. +{{template "contributors" .}} {{end}} diff --git a/tools/documentation/sub_templates/contributors.tmpl b/tools/documentation/sub_templates/contributors.tmpl new file mode 100644 index 00000000000..123c6ca4316 --- /dev/null +++ b/tools/documentation/sub_templates/contributors.tmpl @@ -0,0 +1,10 @@ +{{define "contributors"}} +## Contributor List + +|User|Github|Contribution Amount| +|--|--|--| +{{ range $contributor := .Contributors -}} +| {{$contributor.Login}} | {{$contributor.URL}} | {{$contributor.Contributions}} | +{{ end }} + +{{end}} From dd00eba27e35532e9933d8179a8dbb03fdec5d4b Mon Sep 17 00:00:00 2001 From: Ryan O'Hara-Reid Date: Tue, 20 Feb 2018 11:56:25 +1100 Subject: [PATCH 4/4] Applied fix to documentation.go for contribution HTML_URL. Added period to documentation templates sentences. Added logic to documentation.go to fix broken links for godoc in sub-packages. Fix coding style to conform to golang idiomatic practice. Applied fix to access main godocs in tools and test data. Generated new documents using tools. --- README.md | 38 +++++++++---------- common/README.md | 4 +- config/README.md | 4 +- currency/README.md | 4 +- currency/pair/README.md | 6 +-- currency/symbol/README.md | 6 +-- currency/translation/README.md | 6 +-- doc/coding_style.md | 1 - events/README.md | 4 +- exchanges/README.md | 4 +- exchanges/nonce/README.md | 6 +-- exchanges/orderbook/README.md | 6 +-- exchanges/stats/README.md | 6 +-- exchanges/ticker/README.md | 6 +-- portfolio/README.md | 4 +- smsglobal/README.md | 4 +- testdata/README.md | 4 +- tools/README.md | 16 +++++--- tools/documentation/documentation.go | 17 ++++++++- .../readme_templates/common_readme.tmpl | 4 +- .../readme_templates/config_readme.tmpl | 4 +- .../currency_pair_readme.tmpl | 4 +- .../readme_templates/currency_readme.tmpl | 4 +- .../currency_symbol_readme.tmpl | 4 +- .../currency_translation_readme.tmpl | 4 +- .../readme_templates/events_readme.tmpl | 4 +- .../exchanges_nonce_readme.tmpl | 4 +- .../exchanges_orderbook_readme.tmpl | 4 +- .../readme_templates/exchanges_readme.tmpl | 4 +- .../exchanges_stats_readme.tmpl | 4 +- .../exchanges_ticker_readme.tmpl | 4 +- .../readme_templates/portfolio_readme.tmpl | 4 +- .../readme_templates/root_readme.tmpl | 18 +++++++++ .../readme_templates/smsglobal_readme.tmpl | 4 +- .../readme_templates/testdata_readme.tmpl | 2 +- .../readme_templates/tools_readme.tmpl | 14 +++++-- .../readme_templates/web_readme.tmpl | 3 +- tools/documentation/sub_templates/header.tmpl | 6 +-- tools/documentation/sub_templates/status.tmpl | 2 +- web/README.md | 3 +- 40 files changed, 146 insertions(+), 104 deletions(-) diff --git a/README.md b/README.md index 6d56dfe2061..0c16eba5d53 100644 --- a/README.md +++ b/README.md @@ -140,25 +140,25 @@ Binaries will be published once the codebase reaches a stable condition. |User|Github|Contribution Amount| |--|--|--| -| thrasher- | https://api.github.com/users/thrasher- | 411 | -| gloriousCode | https://api.github.com/users/gloriousCode | 113 | -| shazbert | https://api.github.com/users/shazbert | 108 | -| 140am | https://api.github.com/users/140am | 8 | -| faddat | https://api.github.com/users/faddat | 4 | -| crackcomm | https://api.github.com/users/crackcomm | 3 | -| bretep | https://api.github.com/users/bretep | 2 | -| gam-phon | https://api.github.com/users/gam-phon | 2 | -| cornelk | https://api.github.com/users/cornelk | 2 | -| if1live | https://api.github.com/users/if1live | 2 | -| daniel-cohen | https://api.github.com/users/daniel-cohen | 1 | -| starit | https://api.github.com/users/starit | 1 | -| mattkanwisher | https://api.github.com/users/mattkanwisher | 1 | -| mKurrels | https://api.github.com/users/mKurrels | 1 | -| m1kola | https://api.github.com/users/m1kola | 1 | -| tongxiaofeng | https://api.github.com/users/tongxiaofeng | 1 | -| idealhack | https://api.github.com/users/idealhack | 1 | -| askew- | https://api.github.com/users/askew- | 1 | -| snipesjr | https://api.github.com/users/snipesjr | 1 | +| thrasher- | https://github.com/thrasher- | 413 | +| gloriousCode | https://github.com/gloriousCode | 113 | +| shazbert | https://github.com/shazbert | 108 | +| 140am | https://github.com/140am | 8 | +| faddat | https://github.com/faddat | 4 | +| crackcomm | https://github.com/crackcomm | 3 | +| bretep | https://github.com/bretep | 2 | +| gam-phon | https://github.com/gam-phon | 2 | +| cornelk | https://github.com/cornelk | 2 | +| if1live | https://github.com/if1live | 2 | +| daniel-cohen | https://github.com/daniel-cohen | 1 | +| starit | https://github.com/starit | 1 | +| mattkanwisher | https://github.com/mattkanwisher | 1 | +| mKurrels | https://github.com/mKurrels | 1 | +| m1kola | https://github.com/m1kola | 1 | +| tongxiaofeng | https://github.com/tongxiaofeng | 1 | +| idealhack | https://github.com/idealhack | 1 | +| askew- | https://github.com/askew- | 1 | +| snipesjr | https://github.com/snipesjr | 1 | diff --git a/common/README.md b/common/README.md index 2619184792a..18139386550 100644 --- a/common/README.md +++ b/common/README.md @@ -10,7 +10,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This common package is part of the GoCryptoTrader codebase +This common package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ## Current Features for common -+ This package collates basic broad functions that are used throughout this codebase ++ This package collates basic broad functions that are used throughout this codebase. ### Please click GoDocs chevron above to view current GoDoc information for this package diff --git a/config/README.md b/config/README.md index a03e34b5315..98095f44a75 100644 --- a/config/README.md +++ b/config/README.md @@ -10,7 +10,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This config package is part of the GoCryptoTrader codebase +This config package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ## Current Features for config -+ This package deals with configuration utilities ++ This package deals with configuration utilities. ### Please click GoDocs chevron above to view current GoDoc information for this package diff --git a/currency/README.md b/currency/README.md index 18be21e396c..4a992014f5c 100644 --- a/currency/README.md +++ b/currency/README.md @@ -10,7 +10,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This currency package is part of the GoCryptoTrader codebase +This currency package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ## Current Features for currency -+ Currency package deals with currency pair generation, manipulation and tracking ++ Currency package deals with currency pair generation, manipulation and tracking. ### Please click GoDocs chevron above to view current GoDoc information for this package diff --git a/currency/pair/README.md b/currency/pair/README.md index 0e620800dd7..fac1f4aac47 100644 --- a/currency/pair/README.md +++ b/currency/pair/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/currency pair) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/currency/pair) [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This currency pair package is part of the GoCryptoTrader codebase +This currency pair package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ## Current Features for currency pair -+ This package services the currency package ++ This package services the currency package. ### Please click GoDocs chevron above to view current GoDoc information for this package diff --git a/currency/symbol/README.md b/currency/symbol/README.md index 37807fe3cc7..9c4caeec5d4 100644 --- a/currency/symbol/README.md +++ b/currency/symbol/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/currency symbol) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/currency/symbol) [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This currency symbol package is part of the GoCryptoTrader codebase +This currency symbol package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ## Current Features for currency symbol -+ This package services the currency package ++ This package services the currency package. ### Please click GoDocs chevron above to view current GoDoc information for this package diff --git a/currency/translation/README.md b/currency/translation/README.md index e1499fd9716..47e35fe6944 100644 --- a/currency/translation/README.md +++ b/currency/translation/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/currency translation) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/currency/translation) [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This currency translation package is part of the GoCryptoTrader codebase +This currency translation package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ## Current Features for currency translation -+ This package services the currency package with translation functions ++ This package services the currency package with translation functions. ### Please click GoDocs chevron above to view current GoDoc information for this package diff --git a/doc/coding_style.md b/doc/coding_style.md index 33a8d37486a..ec7e19565cc 100644 --- a/doc/coding_style.md +++ b/doc/coding_style.md @@ -20,7 +20,6 @@ func SendHTTPRequest(method, path string, headers map[string]string, body io.Rea } req, err := http.NewRequest(method, path, body) - if err != nil { return "", err } diff --git a/events/README.md b/events/README.md index 3ce3298cc70..73250d7168a 100644 --- a/events/README.md +++ b/events/README.md @@ -10,7 +10,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This events package is part of the GoCryptoTrader codebase +This events package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ## Current Features for events -+ The events package handles events from GoCryptoTrader bot ++ The events package handles events from GoCryptoTrader bot. ### Please click GoDocs chevron above to view current GoDoc information for this package diff --git a/exchanges/README.md b/exchanges/README.md index 1f2377b6c60..f7cac594145 100644 --- a/exchanges/README.md +++ b/exchanges/README.md @@ -10,7 +10,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This exchanges package is part of the GoCryptoTrader codebase +This exchanges package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ## Current Features for exchanges -+ This package is used to connect and query data from supported exchanges ++ This package is used to connect and query data from supported exchanges. ### Please click GoDocs chevron above to view current GoDoc information for this package diff --git a/exchanges/nonce/README.md b/exchanges/nonce/README.md index c53e9666257..c6ee0b60de0 100644 --- a/exchanges/nonce/README.md +++ b/exchanges/nonce/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges nonce) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges/nonce) [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This exchanges nonce package is part of the GoCryptoTrader codebase +This exchanges nonce package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ## Current Features for exchanges nonce -+ This package services the exchanges package with nonce creation ++ This package services the exchanges package with nonce creation. ### Please click GoDocs chevron above to view current GoDoc information for this package diff --git a/exchanges/orderbook/README.md b/exchanges/orderbook/README.md index 565b6ab930c..a3b2089011c 100644 --- a/exchanges/orderbook/README.md +++ b/exchanges/orderbook/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges orderbook) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges/orderbook) [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This exchanges orderbook package is part of the GoCryptoTrader codebase +This exchanges orderbook package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ## Current Features for exchanges orderbook -+ This package facilitates orderbook generation ++ This package facilitates orderbook generation. ### Please click GoDocs chevron above to view current GoDoc information for this package diff --git a/exchanges/stats/README.md b/exchanges/stats/README.md index 3c332aea01d..647c7359c94 100644 --- a/exchanges/stats/README.md +++ b/exchanges/stats/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges stats) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges/stats) [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This exchanges stats package is part of the GoCryptoTrader codebase +This exchanges stats package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ## Current Features for exchanges stats -+ This package services the exchanges package ++ This package services the exchanges package. ### Please click GoDocs chevron above to view current GoDoc information for this package diff --git a/exchanges/ticker/README.md b/exchanges/ticker/README.md index eacba5f2c82..ec93b1724c3 100644 --- a/exchanges/ticker/README.md +++ b/exchanges/ticker/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges ticker) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/exchanges/ticker) [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This exchanges ticker package is part of the GoCryptoTrader codebase +This exchanges ticker package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ## Current Features for exchanges ticker -+ This services the exchanges package by ticker functions ++ This services the exchanges package by ticker functions. ### Please click GoDocs chevron above to view current GoDoc information for this package diff --git a/portfolio/README.md b/portfolio/README.md index e1edbbac1c3..cf6ecf37d8f 100644 --- a/portfolio/README.md +++ b/portfolio/README.md @@ -10,7 +10,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This portfolio package is part of the GoCryptoTrader codebase +This portfolio package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ## Current Features for portfolio -+ This package allows for the monitoring of portfolio data ++ This package allows for the monitoring of portfolio data. ### Please click GoDocs chevron above to view current GoDoc information for this package diff --git a/smsglobal/README.md b/smsglobal/README.md index 17ce3d082ab..9c0c6970d68 100644 --- a/smsglobal/README.md +++ b/smsglobal/README.md @@ -10,7 +10,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This smsglobal package is part of the GoCryptoTrader codebase +This smsglobal package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ## Current Features for smsglobal -+ This package allows for the messaging of events to a personal phone number or a group of phone numbers ++ This package allows for the messaging of events to a personal phone number or a group of phone numbers. ### Please click GoDocs chevron above to view current GoDoc information for this package diff --git a/testdata/README.md b/testdata/README.md index 85f332e0c2b..d1b4f70f72b 100644 --- a/testdata/README.md +++ b/testdata/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/testdata) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/ [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This testdata package is part of the GoCryptoTrader codebase +This testdata package is part of the GoCryptoTrader codebase. ## This is still in active development diff --git a/tools/README.md b/tools/README.md index 77376b8653d..df1a0ab374f 100644 --- a/tools/README.md +++ b/tools/README.md @@ -5,12 +5,12 @@ [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/tools) +[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/ [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This tools package is part of the GoCryptoTrader codebase +This tools package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ## Current Features -This folder contains an assortment of tools +This folder contains an assortment of tools. + Configuration + Documentation creation @@ -29,10 +29,16 @@ This folder contains an assortment of tools + Websocket client -Example Run for documentation generation - flags -v Verbose & -R Replace files +Example Run for documentation generation - flags -v Verbose & -r Replace files +```sh +cd documentation/ +go run documentation.go -v ``` +OR for full replacement. + +```sh cd documentation/ -go run documentation -v +go run documentation.go -v -r ``` ## Contribution diff --git a/tools/documentation/documentation.go b/tools/documentation/documentation.go index 6c56621eab0..449af06234a 100644 --- a/tools/documentation/documentation.go +++ b/tools/documentation/documentation.go @@ -6,6 +6,7 @@ import ( "html/template" "log" "os" + "strings" "github.com/thrasher-/gocryptotrader/common" ) @@ -46,11 +47,12 @@ var ( type readme struct { Name string Contributors []contributor + NameURL string } type contributor struct { Login string `json:"login"` - URL string `json:"url"` + URL string `json:"html_url"` Contributions int `json:"contributions"` } @@ -153,10 +155,23 @@ func addReadmeData(packageName string) { readmeInfo := readme{ Name: packageName, Contributors: contributors, + NameURL: getslashFromName(packageName), } codebaseReadme[packageName] = readmeInfo } +// returns a string for godoc package names +func getslashFromName(packageName string) string { + if strings.Contains(packageName, " ") { + s := strings.Split(packageName, " ") + return strings.Join(s, "/") + } + if packageName == "testdata" || packageName == "tools" { + return "" + } + return packageName +} + // adds all the template files func addTemplates() error { glob, err := template.ParseGlob(fmt.Sprintf("readme_templates%s*", path)) diff --git a/tools/documentation/readme_templates/common_readme.tmpl b/tools/documentation/readme_templates/common_readme.tmpl index ace0be94139..44888af0515 100644 --- a/tools/documentation/readme_templates/common_readme.tmpl +++ b/tools/documentation/readme_templates/common_readme.tmpl @@ -1,8 +1,8 @@ {{define "common" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features for {{.Name}} -+ This package collates basic broad functions that are used throughout this codebase ++ This package collates basic broad functions that are used throughout this codebase. ### Please click GoDocs chevron above to view current GoDoc information for this package {{template "contributions"}} diff --git a/tools/documentation/readme_templates/config_readme.tmpl b/tools/documentation/readme_templates/config_readme.tmpl index 1e74ce84a8b..2510020fb07 100644 --- a/tools/documentation/readme_templates/config_readme.tmpl +++ b/tools/documentation/readme_templates/config_readme.tmpl @@ -1,8 +1,8 @@ {{define "config" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features for {{.Name}} -+ This package deals with configuration utilities ++ This package deals with configuration utilities. ### Please click GoDocs chevron above to view current GoDoc information for this package {{template "contributions"}} diff --git a/tools/documentation/readme_templates/currency_pair_readme.tmpl b/tools/documentation/readme_templates/currency_pair_readme.tmpl index 92b9ff2f8f7..042285ab246 100644 --- a/tools/documentation/readme_templates/currency_pair_readme.tmpl +++ b/tools/documentation/readme_templates/currency_pair_readme.tmpl @@ -1,8 +1,8 @@ {{define "currency pair" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features for {{.Name}} -+ This package services the currency package ++ This package services the currency package. ### Please click GoDocs chevron above to view current GoDoc information for this package {{template "contributions"}} diff --git a/tools/documentation/readme_templates/currency_readme.tmpl b/tools/documentation/readme_templates/currency_readme.tmpl index fb1b1242a09..7cdf48ed8e4 100644 --- a/tools/documentation/readme_templates/currency_readme.tmpl +++ b/tools/documentation/readme_templates/currency_readme.tmpl @@ -1,8 +1,8 @@ {{define "currency" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features for {{.Name}} -+ Currency package deals with currency pair generation, manipulation and tracking ++ Currency package deals with currency pair generation, manipulation and tracking. ### Please click GoDocs chevron above to view current GoDoc information for this package {{template "contributions"}} diff --git a/tools/documentation/readme_templates/currency_symbol_readme.tmpl b/tools/documentation/readme_templates/currency_symbol_readme.tmpl index d020ac0b002..424ad8112ce 100644 --- a/tools/documentation/readme_templates/currency_symbol_readme.tmpl +++ b/tools/documentation/readme_templates/currency_symbol_readme.tmpl @@ -1,8 +1,8 @@ {{define "currency symbol" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features for {{.Name}} -+ This package services the currency package ++ This package services the currency package. ### Please click GoDocs chevron above to view current GoDoc information for this package {{template "contributions"}} diff --git a/tools/documentation/readme_templates/currency_translation_readme.tmpl b/tools/documentation/readme_templates/currency_translation_readme.tmpl index e127a46e804..b383128ac28 100644 --- a/tools/documentation/readme_templates/currency_translation_readme.tmpl +++ b/tools/documentation/readme_templates/currency_translation_readme.tmpl @@ -1,8 +1,8 @@ {{define "currency translation" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features for {{.Name}} -+ This package services the currency package with translation functions ++ This package services the currency package with translation functions. ### Please click GoDocs chevron above to view current GoDoc information for this package {{template "contributions"}} diff --git a/tools/documentation/readme_templates/events_readme.tmpl b/tools/documentation/readme_templates/events_readme.tmpl index d61fa9e63ed..b9a9367cb7c 100644 --- a/tools/documentation/readme_templates/events_readme.tmpl +++ b/tools/documentation/readme_templates/events_readme.tmpl @@ -1,8 +1,8 @@ {{define "events" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features for {{.Name}} -+ The events package handles events from GoCryptoTrader bot ++ The events package handles events from GoCryptoTrader bot. ### Please click GoDocs chevron above to view current GoDoc information for this package {{template "contributions"}} diff --git a/tools/documentation/readme_templates/exchanges_nonce_readme.tmpl b/tools/documentation/readme_templates/exchanges_nonce_readme.tmpl index e5ce29625dc..b969c4abc32 100644 --- a/tools/documentation/readme_templates/exchanges_nonce_readme.tmpl +++ b/tools/documentation/readme_templates/exchanges_nonce_readme.tmpl @@ -1,8 +1,8 @@ {{define "exchanges nonce" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features for {{.Name}} -+ This package services the exchanges package with nonce creation ++ This package services the exchanges package with nonce creation. ### Please click GoDocs chevron above to view current GoDoc information for this package {{template "contributions"}} diff --git a/tools/documentation/readme_templates/exchanges_orderbook_readme.tmpl b/tools/documentation/readme_templates/exchanges_orderbook_readme.tmpl index 9afb871d4a1..ccb4d40b236 100644 --- a/tools/documentation/readme_templates/exchanges_orderbook_readme.tmpl +++ b/tools/documentation/readme_templates/exchanges_orderbook_readme.tmpl @@ -1,8 +1,8 @@ {{define "exchanges orderbook" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features for {{.Name}} -+ This package facilitates orderbook generation ++ This package facilitates orderbook generation. ### Please click GoDocs chevron above to view current GoDoc information for this package {{template "contributions"}} diff --git a/tools/documentation/readme_templates/exchanges_readme.tmpl b/tools/documentation/readme_templates/exchanges_readme.tmpl index 0f8b6b35763..f4f9cf77c92 100644 --- a/tools/documentation/readme_templates/exchanges_readme.tmpl +++ b/tools/documentation/readme_templates/exchanges_readme.tmpl @@ -1,8 +1,8 @@ {{define "exchanges" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features for {{.Name}} -+ This package is used to connect and query data from supported exchanges ++ This package is used to connect and query data from supported exchanges. ### Please click GoDocs chevron above to view current GoDoc information for this package {{template "contributions"}} diff --git a/tools/documentation/readme_templates/exchanges_stats_readme.tmpl b/tools/documentation/readme_templates/exchanges_stats_readme.tmpl index dacf0cba1c7..f0bdc956063 100644 --- a/tools/documentation/readme_templates/exchanges_stats_readme.tmpl +++ b/tools/documentation/readme_templates/exchanges_stats_readme.tmpl @@ -1,8 +1,8 @@ {{define "exchanges stats" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features for {{.Name}} -+ This package services the exchanges package ++ This package services the exchanges package. ### Please click GoDocs chevron above to view current GoDoc information for this package {{template "contributions"}} diff --git a/tools/documentation/readme_templates/exchanges_ticker_readme.tmpl b/tools/documentation/readme_templates/exchanges_ticker_readme.tmpl index 35f3d031f91..c848e11fa78 100644 --- a/tools/documentation/readme_templates/exchanges_ticker_readme.tmpl +++ b/tools/documentation/readme_templates/exchanges_ticker_readme.tmpl @@ -1,8 +1,8 @@ {{define "exchanges ticker" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features for {{.Name}} -+ This services the exchanges package by ticker functions ++ This services the exchanges package by ticker functions. ### Please click GoDocs chevron above to view current GoDoc information for this package {{template "contributions"}} diff --git a/tools/documentation/readme_templates/portfolio_readme.tmpl b/tools/documentation/readme_templates/portfolio_readme.tmpl index 68ced8876c4..03dec8c0c7d 100644 --- a/tools/documentation/readme_templates/portfolio_readme.tmpl +++ b/tools/documentation/readme_templates/portfolio_readme.tmpl @@ -1,8 +1,8 @@ {{define "portfolio" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features for {{.Name}} -+ This package allows for the monitoring of portfolio data ++ This package allows for the monitoring of portfolio data. ### Please click GoDocs chevron above to view current GoDoc information for this package {{template "contributions"}} diff --git a/tools/documentation/readme_templates/root_readme.tmpl b/tools/documentation/readme_templates/root_readme.tmpl index d12ca03c42b..ff7ef845c82 100644 --- a/tools/documentation/readme_templates/root_readme.tmpl +++ b/tools/documentation/readme_templates/root_readme.tmpl @@ -87,6 +87,24 @@ platform. ### Linux/OSX +We use the `dep` tool provided by Golang for managing dependencies. As it is not officially part +of the go tools package suite, you will need to manually install it if you have not already. + +On MacOS you can install or upgrade to the latest released version with Homebrew: + +```sh +brew install dep +brew upgrade dep +``` + +On linux or MacOS, you can also install it via `go get`: + +```sh +go get -u github.com/golang/dep/cmd/dep +``` + +After `dep` is installed, please follow the instructions below: + ```bash go get github.com/thrasher-/gocryptotrader cd $GOPATH/src/github.com/thrasher-/gocryptotrader diff --git a/tools/documentation/readme_templates/smsglobal_readme.tmpl b/tools/documentation/readme_templates/smsglobal_readme.tmpl index 98d025c7997..7b651e3a6e7 100644 --- a/tools/documentation/readme_templates/smsglobal_readme.tmpl +++ b/tools/documentation/readme_templates/smsglobal_readme.tmpl @@ -1,8 +1,8 @@ {{define "smsglobal" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features for {{.Name}} -+ This package allows for the messaging of events to a personal phone number or a group of phone numbers ++ This package allows for the messaging of events to a personal phone number or a group of phone numbers. ### Please click GoDocs chevron above to view current GoDoc information for this package {{template "contributions"}} diff --git a/tools/documentation/readme_templates/testdata_readme.tmpl b/tools/documentation/readme_templates/testdata_readme.tmpl index 30b42453a7b..15a6e5d9577 100644 --- a/tools/documentation/readme_templates/testdata_readme.tmpl +++ b/tools/documentation/readme_templates/testdata_readme.tmpl @@ -1,5 +1,5 @@ {{define "testdata" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features This folder contains a configuration test file for non-deployement test params. diff --git a/tools/documentation/readme_templates/tools_readme.tmpl b/tools/documentation/readme_templates/tools_readme.tmpl index f447eaff666..6789effa245 100644 --- a/tools/documentation/readme_templates/tools_readme.tmpl +++ b/tools/documentation/readme_templates/tools_readme.tmpl @@ -1,8 +1,8 @@ {{define "tools" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features -This folder contains an assortment of tools +This folder contains an assortment of tools. + Configuration + Documentation creation @@ -11,10 +11,16 @@ This folder contains an assortment of tools + Websocket client -Example Run for documentation generation - flags -v Verbose & -R Replace files +Example Run for documentation generation - flags -v Verbose & -r Replace files +```sh +cd documentation/ +go run documentation.go -v ``` +OR for full replacement. + +```sh cd documentation/ -go run documentation -v +go run documentation.go -v -r ``` {{template "contributions"}} {{template "donations"}} diff --git a/tools/documentation/readme_templates/web_readme.tmpl b/tools/documentation/readme_templates/web_readme.tmpl index be927649ba3..9d6a5b52f07 100644 --- a/tools/documentation/readme_templates/web_readme.tmpl +++ b/tools/documentation/readme_templates/web_readme.tmpl @@ -1,8 +1,7 @@ {{define "web" -}} -{{template "header" .Name}} +{{template "header" .}} ## Current Features - + It can run + It can be compiled with Electron to run as an executable + Websocket support to listen to GoCryptoTrader events diff --git a/tools/documentation/sub_templates/header.tmpl b/tools/documentation/sub_templates/header.tmpl index 5e2ea1a3305..b6144bd8f77 100644 --- a/tools/documentation/sub_templates/header.tmpl +++ b/tools/documentation/sub_templates/header.tmpl @@ -1,11 +1,11 @@ {{define "header" -}} -# GoCryptoTrader package {{.}} +# GoCryptoTrader package {{.Name}} -{{template "status" .}} +{{template "status" .NameURL}} -This {{.}} package is part of the GoCryptoTrader codebase +This {{.Name}} package is part of the GoCryptoTrader codebase. ## This is still in active development diff --git a/tools/documentation/sub_templates/status.tmpl b/tools/documentation/sub_templates/status.tmpl index 71de2a8461d..82efe96eaea 100644 --- a/tools/documentation/sub_templates/status.tmpl +++ b/tools/documentation/sub_templates/status.tmpl @@ -1,7 +1,7 @@ {{define "status"}} [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) -[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/{{.}}) +{{with .}}[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/{{.}}){{else}}[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/){{end}} [![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) {{end}} diff --git a/web/README.md b/web/README.md index 61d01df4140..9991ecdacb7 100644 --- a/web/README.md +++ b/web/README.md @@ -10,7 +10,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This web package is part of the GoCryptoTrader codebase +This web package is part of the GoCryptoTrader codebase. ## This is still in active development @@ -20,7 +20,6 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader ## Current Features - + It can run + It can be compiled with Electron to run as an executable + Websocket support to listen to GoCryptoTrader events