From 9ee41b7af54426f1bc09db8a91cc44c995310d9a Mon Sep 17 00:00:00 2001 From: Alex Clarke Date: Wed, 30 Oct 2024 16:43:38 -0600 Subject: [PATCH] Updated README to a more polished format for the alpha release --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 34c5adf..c5bcd66 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,14 @@ cargo install managarr cargo install --locked managarr ``` +### Docker +Run Managarr as a docker container by mounting your `config.yml` file to `/root/.config/managarr/config.yml`. For example: +```shell +docker run --rm -it -v ~/.config/managarr:/root/.config/managarr darkalex17/managarr +``` + +You can also clone this repo and run `make docker` to build a docker image locally and run it using the above command. + ## Features ### Radarr @@ -156,16 +164,6 @@ $ managarr radarr list movies | jq '.[] | select(.title == "Ad Astra") | .id' 277 ``` -## Installation - -### Docker -Run Managarr as a docker container by mounting your `config.yml` file to `/root/.config/managarr/config.yml`. For example: -```shell -docker run --rm -it -v ~/.config/managarr:/root/.config/managarr darkalex17/managarr -``` - -You can also clone this repo and run `make docker` to build a docker image locally and run it using the above command. - # Configuration Managarr assumes reasonable defaults to connect to each service (i.e. Radarr is on localhost:7878), but all servers will require you to input the API token.