add README; minor refactoring

README.md

@@ -1,14 +1,52 @@
-# marginbot
+# freqtrade
+Simple High frequency trading bot for crypto currencies.
+Currently supported exchanges: bittrex, poloniex (partly implemented)
 
-Cryptocurrency micro trading bot
+This software is for educational purposes only.
+Don't risk money which you are afraid to lose.
+
+The command interface is accessible via Telegram (not required).
+Just register a new bot on https://telegram.me/BotFather
+and enter the telegram `token` and your `chat_id` in `config.json`
+
+Persistence is achieved through sqlite.
+
+##### Telegram RPC commands:
+* /start: Starts the trader
+* /stop: Stops the trader
+* /status: Lists all open trades
+* /profit: Lists cumulative profit from all finished trades
+
+##### Config
+`trade_thresholds` is a JSON object where the key is a duration
+in minutes and the value is the minimum profit threshold in
+percent whether the bot should sell. See the example below:
 
 ```
-cd marginbot/
-cp config.json.example config.json
-python -m venv .venv
-source .venv/bin/activate
-pip install -r requirements.txt
-./main.py
+"trade_thresholds": {
+    "2880": 0.005, # Sell after 48 hours if there is at least 0.5% profit
+    "1440": 0.01,  # Sell after 24 hours if there is at least 1% profit
+    "720":  0.02,  # Sell after 12 hours if there is at least 2% profit
+    "360":  0.02,  # Sell after 6 hours if there is at least 2% profit
+    "0":    0.025  # Sell immediatly if there is at least 2.5% profit
+},
 ```
 
-Enter your API keys and tokens in `config.json`
+
+The other values should be self-explanatory,
+if not feel free to raise a github issue.
+
+##### Prerequisites
+* python3
+* sqlite
+
+##### Install
+```
+$ cd freqtrade/
+# copy example config. Dont forget to insert your api keys
+$ cp config.json.example config.json
+$ python -m venv .env
+$ source .env/bin/activate
+$ pip install -r requirements.txt
+$ ./main.py
+```