From 2e27409531cd890a8a40d908922e5198fa6d3e7a Mon Sep 17 00:00:00 2001 From: Michael Feng Date: Tue, 4 Apr 2023 16:22:56 -0700 Subject: [PATCH] clarify readme --- autostart_hummingbot_compose/README.md | 2 +- multiple_hummingbot_gateway_compose/README.md | 2 +- simple_hummingbot_compose/README.md | 8 +++----- 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/autostart_hummingbot_compose/README.md b/autostart_hummingbot_compose/README.md index f90f382..ad5fda4 100644 --- a/autostart_hummingbot_compose/README.md +++ b/autostart_hummingbot_compose/README.md @@ -1,4 +1,4 @@ -# Deploy and Auto-start a single Hummingbot instance with Docker Compose +# Auto-Start Hummingbot Instance This installs a single [Hummingbot](https://github.com/hummingbot/hummingbot) instance as a Docker container and automatically starts running a pre-configured script or strategy. diff --git a/multiple_hummingbot_gateway_compose/README.md b/multiple_hummingbot_gateway_compose/README.md index d1d82d8..1a3109b 100644 --- a/multiple_hummingbot_gateway_compose/README.md +++ b/multiple_hummingbot_gateway_compose/README.md @@ -1,4 +1,4 @@ -# Deploy: Hummingbot + Gateway +# Deploy Hummingbot and Gateway Instances ## How to use it diff --git a/simple_hummingbot_compose/README.md b/simple_hummingbot_compose/README.md index 7917535..82b9a61 100644 --- a/simple_hummingbot_compose/README.md +++ b/simple_hummingbot_compose/README.md @@ -1,4 +1,4 @@ -# Deploy a single Hummingbot instance with Docker Compose +# Deploy Hummingbot Instance This installs a single [Hummingbot](https://github.com/hummingbot/hummingbot) instance as a Docker container. @@ -36,10 +36,8 @@ docker-compose Usage: docker compose [OPTIONS] COMMAND ``` - Clone this repo or copy the `docker-compose.yml` file to a directory on your machine where you want to store your Hummingbot files. This is where your encrypted keys, scripts, trades, configs, logs, and other files related to your bots will be saved. - From that directory, run the following command to pull the image and start the instance: ``` docker-compose up -d @@ -63,7 +61,7 @@ If installation was successful, you should see the Hummingbot welcome screen: To get started with Hummingbot, check out the following docs: * [Basic Features](https://docs.hummingbot.org/operation/) -* [Quickstart Guide](https://docs.hummingbot.org/quickstart/). +* [Quickstart Guide](https://docs.hummingbot.org/quickstart/) * [Hummingbot FAQ](https://docs.hummingbot.org/faq/) ## Useful Docker Commands @@ -80,7 +78,7 @@ docker-compose up -d docker attach simple_hummingbot_compose-bot-1 ``` -### Detach from the instance and return to command line +### Detach from the container and return to command line Press keys Ctrl + P then Ctrl + Q