Updated README to a more polished format for the alpha release
This commit is contained in:
@@ -45,6 +45,14 @@ cargo install managarr
|
|||||||
cargo install --locked 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
|
## Features
|
||||||
|
|
||||||
### Radarr
|
### Radarr
|
||||||
@@ -156,16 +164,6 @@ $ managarr radarr list movies | jq '.[] | select(.title == "Ad Astra") | .id'
|
|||||||
277
|
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
|
# Configuration
|
||||||
Managarr assumes reasonable defaults to connect to each service (i.e. Radarr is on localhost:7878),
|
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.
|
but all servers will require you to input the API token.
|
||||||
|
|||||||
Reference in New Issue
Block a user