Skip to content

Commit

Permalink
docs: Minor docs tweaks (#169)
Browse files Browse the repository at this point in the history
  • Loading branch information
gazbert committed Nov 14, 2024
1 parent f078407 commit fb9eaa1
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Gradle CI](https://github.com/gazbert/bxbot/actions/workflows/gradle.yml/badge.svg?branch=main)](https://github.com/gazbert/bxbot/actions/workflows/gradle.yml)
[![Maven CI](https://github.com/gazbert/bxbot/actions/workflows/maven.yml/badge.svg?branch=main)](https://github.com/gazbert/bxbot/actions/workflows/maven.yml)
[![Sonarcloud Status](https://sonarcloud.io/api/project_badges/measure?project=gazbert_bxbot&metric=alert_status)](https://sonarcloud.io/dashboard?id=gazbert_bxbot)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
[![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)

## What is BX-bot?
Expand Down Expand Up @@ -181,7 +181,7 @@ engine:
botName: Bitstamp Bot
emergencyStopCurrency: BTC
emergencyStopBalance: 1.0
tradeCycleInterval: 20
tradeCycleInterval: 30
```
All fields are mandatory.
Expand All @@ -193,7 +193,7 @@ All fields are mandatory.

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

* The `emergencyStopBalance` value must be set to prevent catastrophic loss on the exchange.
Expand Down
6 changes: 3 additions & 3 deletions config/engine.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ engine:

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

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

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

0 comments on commit fb9eaa1

Please sign in to comment.