From 4d8fdbae421f0a1d4aa5d555709fc98dfaaba757 Mon Sep 17 00:00:00 2001 From: mootz12 Date: Tue, 8 Oct 2024 14:03:02 -0400 Subject: [PATCH] chore: clean up getting started wording in readme --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3bb69d8..44ce641 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,11 @@ It is recommended to run the auctioneer bot as a docker container. The image can docker pull script3/auctioneer-bot:latest ``` -To run the container, you will need to provide a volume mount from the host to `/app/data` with a config file named `config.json` at the root of the volume. Please see [Configuration](#configuration) for documentation of the configuration file. +To run the container, you will need to mount a directory from the host to `/app/data` on the container. The directory must contain a config file named `config.json` at its root. Please see [Configuration](#configuration) for details on the configuration file. -The container will create a sqlite3 database that tracks bot activity and log files outputted by the bot in the mounted volume. +The container will create a sqlite3 database that tracks bot activity and log files in the mounted directory. +Use the following command to run the container: ```bash docker run --restart always -d -v /path/on/host:/app/data script3/auctioneer-bot:latest ```