From a272e5e398635ff00823811d8e7dbf8ad3e85664 Mon Sep 17 00:00:00 2001 From: Adrian Gallagher Date: Tue, 8 Aug 2017 17:26:09 +1000 Subject: [PATCH] Update README.md --- README.md | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 54e690f7..d4e48078 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ A cryptocurrency trading bot supporting multiple exchanges written in Golang. ## Community -Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader](https://gocryptotrader.herokuapp.com/) +Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) ## Exchange Support Table @@ -35,24 +35,25 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader] | OKCoin (both) | Yes | Yes | No | | Poloniex | Yes | Yes | 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 -+ WebGUI. -+ FIX support. -+ Expanding event trigger system. -+ TALib. -+ Trade history summary generation for tax purposes. -+ ZMQ Hub for manging different gocryptotrader instances. +Planned features can be found on our [community Trello page](https://trello.com/b/ZAhMhpOy/gocryptotrader). ## Contribution @@ -66,12 +67,18 @@ When submitting a PR, please abide by our coding guidelines: * Pull requests need to be based on and opened against the `master` branch. ## Compiling instructions -Download Go from https://golang.org/dl/ -Using a terminal, type go get github.com/thrasher-/gocryptotrader -Change directory to the package directory, then type go install. -Copy config_example.dat to config.dat. +Download and install Go from https://golang.org/dl/ +``` +go get github.com/thrasher-/gocryptotrader +cd $GOPATH/src/github.com/thrasher-/gocryptotrader +go install +cp $GOPATH/src/github.com/thrasher-/gocryptotrader/config_example.dat $GOPATH/bin/config.dat +``` Make any neccessary changes to the config file. Run the application! +## 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.