From 963d2a8368b671c04e390ce24a818778846368d4 Mon Sep 17 00:00:00 2001 From: Gerald Lonlas Date: Tue, 29 May 2018 22:24:13 -0700 Subject: [PATCH] Doc: update bot usage --- README.md | 18 ++++++++++++------ docs/bot-usage.md | 14 ++++++++------ 2 files changed, 20 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 3546416df..3d90a0a8c 100644 --- a/README.md +++ b/README.md @@ -144,8 +144,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] - [--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} ... Simple High Frequency Trading Bot for crypto currencies @@ -161,13 +162,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 - "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 + -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 --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) diff --git a/docs/bot-usage.md b/docs/bot-usage.md index 075413b21..b42df3ba3 100644 --- a/docs/bot-usage.md +++ b/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?