From c1bc1e31373f2159c650a1f0d7580f0ddf26f675 Mon Sep 17 00:00:00 2001
From: Matthias <xmatthias@outlook.com>
Date: Sun, 28 Jul 2019 15:34:49 +0200
Subject: [PATCH] Add documentation for user_data_dir

---
 docs/bot-usage.md     | 50 ++++++++++++++++++++++++++++++++-----------
 docs/configuration.md |  1 +
 2 files changed, 38 insertions(+), 13 deletions(-)

diff --git a/docs/bot-usage.md b/docs/bot-usage.md
index ef28eb60c..f407e6a23 100644
--- a/docs/bot-usage.md
+++ b/docs/bot-usage.md
@@ -9,38 +9,43 @@ This page explains the different parameters of the bot and how to run it.
 ## Bot commands
 
 ```
-usage: freqtrade [-h] [-v] [--logfile FILE] [--version] [-c PATH] [-d PATH]
-                 [-s NAME] [--strategy-path PATH] [--db-url PATH]
-                 [--sd-notify]
-                 {backtesting,edge,hyperopt} ...
+usage: freqtrade [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH]
+                 [--userdir PATH] [-s NAME] [--strategy-path PATH]
+                 [--db-url PATH] [--sd-notify]
+                 {backtesting,edge,hyperopt,create-userdir,list-exchanges} ...
 
 Free, open source crypto trading bot
 
 positional arguments:
-  {backtesting,edge,hyperopt}
+  {backtesting,edge,hyperopt,create-userdir,list-exchanges}
     backtesting         Backtesting module.
     edge                Edge module.
     hyperopt            Hyperopt module.
+    create-userdir      Create user-data directory.
+    list-exchanges      Print available exchanges.
 
 optional arguments:
   -h, --help            show this help message and exit
   -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
-  --logfile FILE        Log to the file specified
+  --logfile FILE        Log to the file specified.
   -V, --version         show program's version number and exit
   -c PATH, --config PATH
-                        Specify configuration file (default: None). Multiple
-                        --config options may be used. Can be set to '-' to
-                        read config from stdin.
+                        Specify configuration file (default: `config.json`).
+                        Multiple --config options may be used. Can be set to
+                        `-` to read config from stdin.
   -d PATH, --datadir PATH
                         Path to backtest data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to Userdata Directory.
   -s NAME, --strategy NAME
                         Specify strategy class name (default:
-                        DefaultStrategy).
+                        `DefaultStrategy`).
   --strategy-path PATH  Specify additional strategy lookup path.
-  --db-url PATH         Override trades database URL, this is useful if
-                        dry_run is enabled or in custom deployments (default:
-                        None).
+  --db-url PATH         Override trades database URL, this is useful in custom
+                        deployments (default: `sqlite:///tradesv3.sqlite` for
+                        Live Run mode, `sqlite://` for Dry Run).
   --sd-notify           Notify systemd service manager.
+
 ```
 
 ### How to use a different configuration file?
@@ -82,6 +87,25 @@ of your configuration in the project issues or in the Internet.
 See more details on this technique with examples in the documentation page on
 [configuration](configuration.md).
 
+### Where to store custom data
+
+Freqtrade allows the creation of a user-data directory using `freqtrade create-userdir --userdir someDirectory`.
+This directory will look as follows:
+
+user_data/
+├── backtest_results
+├── data
+├── hyperopts
+├── plot
+└── strategies
+
+You can add the entry "user_data_dir" to your configuration, to always point your bot to this folder.
+Alternatively, pass in `--userdir` to every command.
+
+This directory should contain your custom strategies, custom hyperopts, backtest data (downloaded using either backtesting or the download script) and plot outputs.
+
+It is reccomendet to use version control to keep track of changes to your strategies.
+
 ### How to use **--strategy**?
 
 This parameter will allow you to load your custom strategy class.
diff --git a/docs/configuration.md b/docs/configuration.md
index f8dbbbbbb..34d0e110f 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -71,6 +71,7 @@ Mandatory Parameters are marked as **Required**.
 | `internals.process_throttle_secs` | 5 | **Required.** Set the process throttle. Value in second.
 | `internals.sd_notify` | false | Enables use of the sd_notify protocol to tell systemd service manager about changes in the bot state and issue keep-alive pings. See [here](installation.md#7-optional-configure-freqtrade-as-a-systemd-service) for more details.
 | `logfile` | | Specify Logfile. Uses a rolling strategy of 10 files, with 1Mb per file.
+| `user_data_dir` | cwd()/user_data | Folder containing user data. Defaults to `./user_data/`.
 
 ### Parameters in the strategy