Upgrade documentation

.bot_config.yaml.example

@@ -1,41 +1,47 @@
-exchange_configs: 
-  - exchange: bittrex
-    public_key: your_bittrex_public_key
-    secret_key: your_bittrex_secret_key
-    websocket_enabled: true
-    deposit_addresses: 
-      BTC: "BTC_ADDRESS"
-      ETH: "0xETH_ADDRESS"
-  - exchange: binance
-    public_key: your_binance_public_key
-    secret_key: your_binance_secret_key
-    websocket_enabled: true
-    deposit_addresses: 
-      BTC: "BTC_ADDRESS"
-      ETH: "0xETH_ADDRESS"
+simulation_mode: true
+exchange_configs:
   - exchange: bitfinex
-    public_key: your_bitfinex_public_key
-    secret_key: your_bitfinex_secret_key
-    websocket_enabled: true
-    deposit_addresses: 
-      BTC: "BTC_ADDRESS"
-      ETH: "0xETH_ADDRESS"
+    public_key: bitfinex_public_key
+    secret_key: bitfinex_secret_key
+    deposit_addresses:
+      BTC : bitfinex_deposit_address_btc
+      ETH: bitfinex_deposit_address_eth
+      ZEC: bitfinex_deposit_address_zec
+    fake_balances:
+      BTC: 100
+      ETH: 100
+      ZEC: 100
+      ETC: 100
+  - exchange: hitbtc
+    public_key: hitbtc_public_key
+    secret_key: hitbtc_secret_key
+    deposit_addresses:
+      BTC : hitbtc_deposit_address_btc
+      ETH: hitbtc_deposit_address_eth
+      ZEC: hitbtc_deposit_address_zec
+    fake_balances:
+      BTC: 100
+      ETH: 100
+      ZEC: 100
+      ETC: 100
 strategies:
-  - strategy: your_strategy_name
+  - strategy: strategy_name
     markets:
-      - market: market_logical_name
+      - market: ETH-BTC
         bindings:
-        - exchange: bittrex
-          market_name: market_name_on_bittrex
-        - exchange: binance
-          market_name: market_name_on_binance
         - exchange: bitfinex
-          market_name: market_name_on_bitfinex
-      - market: another_market_logical_name
+          market_name: ETHBTC
+        - exchange: hitbtc
+          market_name: ETHBTC
+      - market: ZEC-BTC
         bindings:
-        - exchange: bittrex
-          market_name: market_name_on_bittrex
-        - exchange: binance
-          market_name: market_name_on_binance
         - exchange: bitfinex
-          market_name: market_name_on_bitfinex
+          market_name: ZECBTC
+        - exchange: hitbtc
+          market_name: ZECBTC
+      - market: ETC-BTC
+        bindings:
+        - exchange: bitfinex
+          market_name: ETCBTC
+        - exchange: hitbtc
+          market_name: ETCBTC

README.md

@@ -8,9 +8,6 @@
 
 A golang implementation of a console-based trading bot for cryptocurrency exchanges. 
 
-## Supported Exchanges
-Bittrex, Poloniex, Binance, Bitfinex and Kraken, other in progress.
-
 ## Usage
 
 Download a release or directly build the code from this repository.
@@ -22,56 +19,81 @@ If you need to, you can create a strategy and bind it to the bot:
 ``` go
 import bot "github.com/saniales/golang-crypto-trading-bot/cmd"
 
-bot.AddCustomStrategy(myStrategy)
-bot.Execute()
+func main() {
+    bot.AddCustomStrategy(myStrategy)
+    bot.Execute()
+}
 ```
 
 For strategy reference see the [Godoc documentation](https://godoc.org/github.com/saniales/golang-crypto-trading-bot).
 
+## Simulation Mode
+
+If enabled, the bot will do paper trading, as it will execute fake orders in a sandbox environment.
+
+A Fake balance for each coin must be specified for each exchange if simulation mode is enabled.
+
+## Supported Exchanges
+
+| Exchange Name | REST Supported    | Websocket Support |
+| ------------- |------------------ | ----------------- |
+| Bittrex       | Yes  	            | No                |   	
+| Poloniex      | Yes  	            | Yes  	            |
+| Kraken        | Yes (no withdraw) | No   	            |
+| Bitfinex      | Yes  	            | Yes  	            |
+| Binance       | Yes  	            | Yes  	            |
+
 # Configuration file template
 Create a configuration file from this example or run the `init` command of the compiled executable.
+
 ``` yaml
-exchange_configs: 
-  - exchange: bittrex
-    public_key: your_bittrex_public_key
-    secret_key: your_bittrex_secret_key
-    websocket_enabled: true
-    deposit_addresses: 
-      BTC: "BTC_ADDRESS"
-      ETH: "0xETH_ADDRESS"
-  - exchange: binance
-    public_key: your_binance_public_key
-    secret_key: your_binance_secret_key
-    websocket_enabled: true
-    deposit_addresses: 
-      BTC: "BTC_ADDRESS"
-      ETH: "0xETH_ADDRESS"
+simulation_mode: true # if you want to enable simulation mode.
+exchange_configs:
   - exchange: bitfinex
-    public_key: your_bitfinex_public_key
-    secret_key: your_bitfinex_secret_key
-    websocket_enabled: true
-    deposit_addresses: 
-      BTC: "BTC_ADDRESS"
-      ETH: "0xETH_ADDRESS"
+    public_key: bitfinex_public_key
+    secret_key: bitfinex_secret_key
+    deposit_addresses:
+      BTC: bitfinex_deposit_address_btc
+      ETH: bitfinex_deposit_address_eth
+      ZEC: bitfinex_deposit_address_zec
+    fake_balances: # used only if simulation mode is enabled, can be omitted if not enabled.
+      BTC: 100
+      ETH: 100
+      ZEC: 100
+      ETC: 100
+  - exchange: hitbtc
+    public_key: hitbtc_public_key
+    secret_key: hitbtc_secret_key
+    deposit_addresses:
+      BTC : hitbtc_deposit_address_btc
+      ETH: hitbtc_deposit_address_eth
+      ZEC: hitbtc_deposit_address_zec
+    fake_balances:
+      BTC: 100
+      ETH: 100
+      ZEC: 100
+      ETC: 100
 strategies:
-  - strategy: your_strategy_name
+  - strategy: strategy_name
     markets:
-      - market: market_logical_name
+      - market: ETH-BTC
+        bindings:
+        - exchange: bitfinex
+          market_name: ETHBTC
+        - exchange: hitbtc
+          market_name: ETHBTC
+      - market: ZEC-BTC
         bindings:
-        - exchange: bittrex
-          market_name: market_name_on_bittrex
-        - exchange: binance
-          market_name: market_name_on_binance
         - exchange: bitfinex
-          market_name: market_name_on_bitfinex
-      - market: another_market_logical_name
+          market_name: ZECBTC
+        - exchange: hitbtc
+          market_name: ZECBTC
+      - market: ETC-BTC
         bindings:
-        - exchange: bittrex
-          market_name: market_name_on_bittrex
-        - exchange: binance
-          market_name: market_name_on_binance
         - exchange: bitfinex
-          market_name: market_name_on_bitfinex
+          market_name: ETCBTC
+        - exchange: hitbtc
+          market_name: ETCBTC
 ```
 
 # Donate