From 7fe0ec540770b46237b4c88187fceee78a263df2 Mon Sep 17 00:00:00 2001 From: gcarq Date: Sun, 25 Mar 2018 16:39:31 +0200 Subject: [PATCH] adapt docs/bot-usage to reflect changes --- docs/bot-usage.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/bot-usage.md b/docs/bot-usage.md index cf3258465..b00377982 100644 --- a/docs/bot-usage.md +++ b/docs/bot-usage.md @@ -26,9 +26,8 @@ optional arguments: --version show program's version number and exit -c PATH, --config PATH specify configuration file (default: config.json) - -s PATH, --strategy PATH - specify strategy file (default: - freqtrade/strategy/default_strategy.py) + -s NAME, --strategy NAME + specify strategy class name (default: DefaultStrategy) --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. @@ -48,21 +47,19 @@ python3 ./freqtrade/main.py -c path/far/far/away/config.json ``` ### How to use --strategy? -This parameter will allow you to load your custom strategy file. Per -default without `--strategy` or `-s` the bot will load the -`default_strategy` included with the bot (`freqtrade/strategy/default_strategy.py`). +This parameter will allow you to load your custom strategy class. +Per default without `--strategy` or `-s` the bot will load the +`DefaultStrategy` included with the bot (`freqtrade/strategy/default_strategy.py`). -The bot will search your strategy file into `user_data/strategies` and -`freqtrade/strategy`. +The bot will search your strategy file within `user_data/strategies` and `freqtrade/strategy`. -To load a strategy, simply pass the file name (without .py) in this -parameters. +To load a strategy, simply pass the class name (e.g.: `CustomStrategy`) in this parameter. **Example:** -In `user_data/strategies` you have a file `my_awesome_strategy.py` to -load it: +In `user_data/strategies` you have a file `my_awesome_strategy.py` which has +a strategy class called `AwesomeStrategy` to load it: ```bash -python3 ./freqtrade/main.py --strategy my_awesome_strategy +python3 ./freqtrade/main.py --strategy AwesomeStrategy ``` If the bot does not find your strategy file, it will display in an error