add test-suite usage to README.md
This commit is contained in:
parent
470f9b76bf
commit
efa0444304
11
README.md
11
README.md
@ -14,7 +14,7 @@ and enter the telegram `token` and your `chat_id` in `config.json`
|
|||||||
|
|
||||||
Persistence is achieved through sqlite.
|
Persistence is achieved through sqlite.
|
||||||
|
|
||||||
##### Telegram RPC commands:
|
#### Telegram RPC commands:
|
||||||
* /start: Starts the trader
|
* /start: Starts the trader
|
||||||
* /stop: Stops the trader
|
* /stop: Stops the trader
|
||||||
* /status: Lists all open trades
|
* /status: Lists all open trades
|
||||||
@ -22,7 +22,7 @@ Persistence is achieved through sqlite.
|
|||||||
* /forcesell <trade_id>: Instantly sells the given trade (Ignoring `minimum_roi`).
|
* /forcesell <trade_id>: Instantly sells the given trade (Ignoring `minimum_roi`).
|
||||||
* /performance: Show performance of each finished trade grouped by pair
|
* /performance: Show performance of each finished trade grouped by pair
|
||||||
|
|
||||||
##### Config
|
#### Config
|
||||||
`minimal_roi` is a JSON object where the key is a duration
|
`minimal_roi` is a JSON object where the key is a duration
|
||||||
in minutes and the value is the minimum ROI in percent.
|
in minutes and the value is the minimum ROI in percent.
|
||||||
See the example below:
|
See the example below:
|
||||||
@ -48,7 +48,7 @@ if not feel free to raise a github issue.
|
|||||||
* sqlite
|
* sqlite
|
||||||
* [TA-lib](https://github.com/mrjbq7/ta-lib#dependencies) binaries
|
* [TA-lib](https://github.com/mrjbq7/ta-lib#dependencies) binaries
|
||||||
|
|
||||||
##### Install
|
#### Install
|
||||||
```
|
```
|
||||||
$ cd freqtrade/
|
$ cd freqtrade/
|
||||||
# copy example config. Dont forget to insert your api keys
|
# copy example config. Dont forget to insert your api keys
|
||||||
@ -59,6 +59,11 @@ $ pip install -r requirements.txt
|
|||||||
$ ./main.py
|
$ ./main.py
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Execute tests
|
||||||
|
|
||||||
|
```
|
||||||
|
$ python -m unittest
|
||||||
|
```
|
||||||
|
|
||||||
#### Docker
|
#### Docker
|
||||||
```
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user