Skip to content

Commit fb9eaa1

Browse files
author
gazbert
committed
docs: Minor docs tweaks (#169)
1 parent f078407 commit fb9eaa1

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Gradle CI](https://github.com/gazbert/bxbot/actions/workflows/gradle.yml/badge.svg?branch=main)](https://github.com/gazbert/bxbot/actions/workflows/gradle.yml)
44
[![Maven CI](https://github.com/gazbert/bxbot/actions/workflows/maven.yml/badge.svg?branch=main)](https://github.com/gazbert/bxbot/actions/workflows/maven.yml)
55
[![Sonarcloud Status](https://sonarcloud.io/api/project_badges/measure?project=gazbert_bxbot&metric=alert_status)](https://sonarcloud.io/dashboard?id=gazbert_bxbot)
6-
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
6+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
77
[![Join the chat at https://gitter.im/BX-bot/Lobby](https://badges.gitter.im/BX-bot/Lobby.svg)](https://gitter.im/BX-bot/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
88

99
## What is BX-bot?
@@ -181,7 +181,7 @@ engine:
181181
botName: Bitstamp Bot
182182
emergencyStopCurrency: BTC
183183
emergencyStopBalance: 1.0
184-
tradeCycleInterval: 20
184+
tradeCycleInterval: 30
185185
```
186186
187187
All fields are mandatory.
@@ -193,7 +193,7 @@ All fields are mandatory.
193193

194194
* The `emergencyStopCurrency` value must be set to prevent catastrophic loss on the exchange.
195195
This is normally the currency you intend to hold a long position in. It should be set to the currency short code for
196-
the wallet, e.g. BTC, LTC, USD. This value can be case sensitive for some exchanges - check the Exchange Adapter
196+
the wallet, e.g. BTC, LTC, USD. This value can be case-sensitive for some exchanges - check the Exchange Adapter
197197
documentation.
198198

199199
* The `emergencyStopBalance` value must be set to prevent catastrophic loss on the exchange.

config/engine.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ engine:
1717

1818
# This must be set to prevent catastrophic loss on the exchange.
1919
# This is normally the currency you intend to hold a long position in. It should be set to the currency short code
20-
# for the wallet, e.g. BTC, LTC, USD. This value can be case sensitive for some exchanges - check the Exchange Adapter
20+
# for the wallet, e.g. BTC, LTC, USD. This value can be case-sensitive for some exchanges - check the Exchange Adapter
2121
# documentation.
2222
emergencyStopCurrency: BTC
2323

@@ -27,9 +27,9 @@ engine:
2727
# Manual intervention is then required to restart the bot. You can set this value to 0 to override this check.
2828
emergencyStopBalance: 1.0
2929

30-
# The is the interval in seconds that the Trading Engine will wait/sleep before executing
30+
# This is the interval in seconds that the Trading Engine will wait/sleep before executing
3131
# the next trade cycle. The minimum value is 1 second. Some exchanges allow you to hit them harder than others.
3232
# However, while their API documentation might say one thing, the reality is you might get socket timeouts and 5XX
3333
# responses if you hit it too hard - you cannot perform ultra low latency trading over the public internet ;-)
3434
# You'll need to experiment with the trade cycle interval for different exchanges.
35-
tradeCycleInterval: 20
35+
tradeCycleInterval: 30

0 commit comments

Comments
 (0)