Merge pull request #788 from gcarq/fix/doc_configuration

Update Readme and documentation

README.md

@@ -56,24 +56,19 @@ Windows, macOS and Linux
 - [x] **Persistence**: Persistence is achieved through sqlite
 - [x] **Dry-run**: Run the bot without playing money.
 - [x] **Backtesting**: Run a simulation of your buy/sell strategy.
-- [x] **Strategy Optimization**: Optimize your buy/sell strategy 
+- [x] **Strategy Optimization by machine learning**: Use machine learning to optimize your buy/sell
-parameters with Hyperopts.
+strategy parameters with real exchange data.
-- [x] **Whitelist crypto-currencies**: Select which crypto-currency you
+- [x] **Whitelist crypto-currencies**: Select which crypto-currency you want to trade.
-want to trade.
+- [x] **Blacklist crypto-currencies**: Select which crypto-currency you want to avoid.
-- [x] **Blacklist crypto-currencies**: Select which crypto-currency you
-want to avoid.
 - [x] **Manageable via Telegram**: Manage the bot with Telegram
-- [x] **Display profit/loss in fiat**: Display your profit/loss in
+- [x] **Display profit/loss in fiat**: Display your profit/loss in 33 fiat.
-33 fiat.
+- [x] **Daily summary of profit/loss**: Provide a daily summary of your profit/loss.
-- [x] **Daily summary of profit/loss**: Provide a daily summary
+- [x] **Performance status report**: Provide a performance status of your current trades.
- of your profit/loss.
-- [x] **Performance status report**: Provide a performance status of 
-your current trades.
 
-### Exchange supported
+### Exchange marketplaces supported
-- [x] Bittrex
+- [X] [Bittrex](https://bittrex.com/)
-- [ ] Binance
+- [X] [Binance](https://www.binance.com/)
-- [ ] Others
+- [ ] [113 others to tests](https://github.com/ccxt/ccxt/). _(We cannot guarantee they will work)_
 
 ## Quick start
 This quick start section is a very short explanation on how to test the 
@@ -144,8 +139,9 @@ to understand the requirements before sending your pull-requests.
 ### Bot commands
 
 ```bash
-usage: main.py [-h] [-v] [--version] [-c PATH] [--dry-run-db] [--datadir PATH]
+usage: main.py [-h] [-v] [--version] [-c PATH] [-d PATH] [-s NAME]
-               [--dynamic-whitelist [INT]]
+               [--strategy-path PATH] [--dynamic-whitelist [INT]]
+               [--dry-run-db]
                {backtesting,hyperopt} ...
 
 Simple High Frequency Trading Bot for crypto currencies
@@ -161,13 +157,18 @@ optional arguments:
   --version             show program's version number and exit
   -c PATH, --config PATH
                         specify configuration file (default: config.json)
-  --dry-run-db          Force dry run to use a local DB
+  -d PATH, --datadir PATH
-                        "tradesv3.dry_run.sqlite" instead of memory DB. Work
+                        path to backtest data (default:
-                        only if dry_run is enabled.
+                        freqtrade/tests/testdata
-  --datadir PATH        path to backtest data (default freqdata/tests/testdata
+  -s NAME, --strategy NAME
+                        specify strategy class name (default: DefaultStrategy)
+  --strategy-path PATH  specify additional strategy lookup path
   --dynamic-whitelist [INT]
                         dynamically generate and update whitelist based on 24h
                         BaseVolume (Default 20 currencies)
+  --dry-run-db          Force dry run to use a local DB
+                        "tradesv3.dry_run.sqlite" instead of memory DB. Work
+                        only if dry_run is enabled.
 ```
 More details on:
 - [How to run the bot](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-usage.md#bot-commands)

docs/bot-usage.md

@@ -9,7 +9,8 @@ it.
 
 ## Bot commands
 ```
-usage: main.py [-h] [-c PATH] [-v] [--version] [--dynamic-whitelist [INT]]
+usage: main.py [-h] [-v] [--version] [-c PATH] [-d PATH] [-s NAME]
+               [--strategy-path PATH] [--dynamic-whitelist [INT]]
                [--dry-run-db]
                {backtesting,hyperopt} ...
 
@@ -26,17 +27,18 @@ optional arguments:
   --version             show program's version number and exit
   -c PATH, --config PATH
                         specify configuration file (default: config.json)
+  -d PATH, --datadir PATH
+                        path to backtest data (default:
+                        freqtrade/tests/testdata
   -s NAME, --strategy NAME
                         specify strategy class name (default: DefaultStrategy)
   --strategy-path PATH  specify additional strategy lookup path
-  --dry-run-db          Force dry run to use a local DB
-                        "tradesv3.dry_run.sqlite" instead of memory DB. Work
-                        only if dry_run is enabled.
-  --datadir PATH
-                        path to backtest data (default freqdata/tests/testdata
   --dynamic-whitelist [INT]
                         dynamically generate and update whitelist based on 24h
                         BaseVolume (Default 20 currencies)
+  --dry-run-db          Force dry run to use a local DB
+                        "tradesv3.dry_run.sqlite" instead of memory DB. Work
+                        only if dry_run is enabled.
 ```
 
 ### How to use a different config file?

docs/configuration.md

@@ -24,7 +24,7 @@ The table below will list all configuration parameters.
 | `stoploss` | -0.10 | No | Value of the stoploss in percent used by the bot. More information below. If set, this parameter will override `stoploss` from your strategy file. 
 | `unfilledtimeout` | 0 | No | How long (in minutes) the bot will wait for an unfilled order to complete, after which the order will be cancelled.
 | `bid_strategy.ask_last_balance` | 0.0 | Yes | Set the bidding price. More information below.
-| `exchange.name` | bittrex | Yes | Name of the exchange class to use.
+| `exchange.name` | bittrex | Yes | Name of the exchange class to use. [List below](#user-content-what-values-for-exchangename).
 | `exchange.key` | key | No | API key to use for the exchange. Only required when you are in production mode.
 | `exchange.secret` | secret | No | API secret to use for the exchange. Only required when you are in production mode.
 | `exchange.pair_whitelist` | [] | No | List of currency to use by the bot. Can be overrided with `--dynamic-whitelist` param.
@@ -79,6 +79,18 @@ use the `last` price and values between those interpolate between ask and last
 price. Using `ask` price will guarantee quick success in bid, but bot will also
 end up paying more then would probably have been necessary.
 
+### What values for exchange.name?
+Freqtrade is based on [CCXT library](https://github.com/ccxt/ccxt) that supports 115 cryptocurrency
+exchange markets and trading APIs. The complete up-to-date list can be found in the
+[CCXT repo homepage](https://github.com/ccxt/ccxt/tree/master/python). However, the bot was tested
+with only Bittrex and Binance.
+
+The bot was tested with the following exchanges:
+- [Bittrex](https://bittrex.com/): "bittrex"
+- [Binance](https://www.binance.com/): "binance"
+
+Feel free to test other exchanges and submit your PR to improve the bot.
+
 ### What values for fiat_display_currency?
 `fiat_display_currency` set the fiat to use for the conversion form coin to fiat in Telegram. 
 The valid value are: "AUD", "BRL", "CAD", "CHF", "CLP", "CNY", "CZK", "DKK", "EUR", "GBP", "HKD", "HUF", "IDR", "ILS", "INR", "JPY", "KRW", "MXN", "MYR", "NOK", "NZD", "PHP", "PKR", "PLN", "RUB", "SEK", "SGD", "THB", "TRY", "TWD", "ZAR", "USD".
@@ -96,7 +108,7 @@ creating trades.
 "dry_run": true,
 ```
 
-3. Remove your Bittrex API key (change them by fake api credentials)
+3. Remove your Exchange API key (change them by fake api credentials)
 ```json
 "exchange": {
         "name": "bittrex",
@@ -122,7 +134,7 @@ you run it in production mode.
 "dry_run": false,
 ```
 
-3. Insert your Bittrex API key (change them by fake api keys)
+3. Insert your Exchange API key (change them by fake api keys)
 ```json
 "exchange": {
         "name": "bittrex",