Skip to content

Commit fd5e786

Browse files
committed
tag with latest
1 parent e88a25d commit fd5e786

File tree

2 files changed

+30
-5
lines changed

2 files changed

+30
-5
lines changed

.github/workflows/build.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ jobs:
4141
type=semver,pattern={{major}}.{{minor}}
4242
type=semver,pattern={{major}}
4343
type=sha
44+
type=raw,value=latest
4445
4546
- name: Login to GitHub Container Registry
4647
uses: docker/login-action@v1

README.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CryptoBot - Binance Trading Bot
22

3-
A python based trading bot for Binance.
3+
A python based trading bot for Binance, which relies heavily on backtesting.
44

55
Currently provides two strategies, *buy_drop_sell_recovery_strategy* and
66
*buy_moon_sell_recovery_strategy*. How these strategies work is described below.
@@ -50,6 +50,14 @@ TICKERS:
5050
NAUGHTY_TIMEOUT: 604800
5151
```
5252

53+
In order to test the different 'profiles' for different coins, this bot is
54+
designed to rely mainly on backtesting. For backtesting, this bot provides two
55+
modes for running.
56+
In the *logmode* it records price.logs for all available coins in binance and
57+
store them in the log directory. These logs can then be consumed in
58+
*backtesting* mode.
59+
60+
5361

5462
## Riot/Matrix:
5563

@@ -62,7 +70,9 @@ Generate a *config.yaml*, see the example configs in *examples/*
6270

6371
And add your Binance credentials to *.secrets.yaml*.
6472

65-
then,
73+
74+
To run the bot in logmode only, which will generate price logs while its
75+
running.
6676

6777
```
6878
docker run -it \
@@ -71,11 +81,11 @@ docker run -it \
7181
-v $PWD/log:/cryptobot/log:rw \
7282
-v $PWD/.secrets.yaml:/cryptobot/.secrets.yaml \
7383
-v $PWD/tickers:/cryptobot/tickers \
74-
ghcr.io/azulinho/cryptobot -s .secrets.yaml -c configs/config.yaml -m live
84+
ghcr.io/azulinho/cryptobot -s .secrets.yaml -c configs/config.yaml -m logmode
7585
7686
```
77-
78-
To run the bot in logmode only,
87+
To run the bot in backtesting, which will perform backtesting on all collected
88+
price logs based on the provided config.yaml.
7989

8090
```
8191
docker run -it \
@@ -88,6 +98,20 @@ docker run -it \
8898
8999
```
90100

101+
Finally, to run in live trading mode,
102+
103+
```
104+
docker run -it \
105+
-u `id -u` \
106+
-v $PWD/configs/:/cryptobot/configs/:ro \
107+
-v $PWD/log:/cryptobot/log:rw \
108+
-v $PWD/.secrets.yaml:/cryptobot/.secrets.yaml \
109+
-v $PWD/tickers:/cryptobot/tickers \
110+
ghcr.io/azulinho/cryptobot -s .secrets.yaml -c configs/config.yaml -m live
111+
112+
```
113+
114+
91115
## Secrets:
92116

93117

0 commit comments

Comments
 (0)