From 97929f34ce5d1dc43da8f28291c63c63c83fa500 Mon Sep 17 00:00:00 2001 From: Luc Timmerman <48736891+Luctia@users.noreply.github.com> Date: Wed, 25 Jan 2023 15:03:08 +0100 Subject: [PATCH] Updated README for clarity --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 98acfd3..ce28301 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ crash*. It doesn't necessarily mean it will run well on your system ;) It featur ### Using the CLI To make things easier, a CLI has been developed. First, clone the repository in a directory of your choosing. You can run it by entering `python main.py` and the CLI will guide you through the -process. +process. Please take a look at [important notes](#important-notes) before you continue. ### Manually 1. To get started, clone the repository in a directory of your choosing. **Note: this will be where @@ -51,8 +51,10 @@ process. out by placing `#` in front of the lines. This ensures they are ignored by Docker compose. 6. Run `docker compose up`. -That's it! Your containers are now up and you can continue to set up the settings in them. Take -note of the following: +That's it! Your containers are now up and you can continue to set up the settings in them. Please +take a look at [important notes](#important-notes) before you continue. + +## Important notes - When linking one service to another, remember to use the container name instead of `localhost`. - Please set the settings of the -arr containers as soon as possible to the following (use advanced):