cphipps/readarr
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Merge pull request #17 from linuxserver/readme-develop-branch

Browse Source 
Add changelog + version tags for develop branch
This commit is contained in:
aptalca
2022-02-21 09:46:58 -05:00
committed by GitHub
parent 270c831383 9059510ffc
commit d671f53e94
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -1,5 +1,5 @@
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-readarr/blob/nightly-alpine/.github/CONTRIBUTING.md -->
<!-- Please read the https://github.com/linuxserver/docker-readarr/blob/develop/.github/CONTRIBUTING.md -->
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
@@ -37,7 +37,7 @@ Find us at:
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/readarr)
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/readarr.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/readarr)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/readarr.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/readarr)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-readarr%2Fjob%2Fnightly-alpine%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-readarr/job/nightly-alpine/)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-readarr%2Fjob%2Fdevelop%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-readarr/job/develop/)
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Freadarr%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/readarr/latest/index.html)
[Readarr](https://github.com/Readarr/Readarr) - Book Manager and Automation (Sonarr for Ebooks)
@@ -48,7 +48,7 @@ Find us at:
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
Simply pulling `lscr.io/linuxserver/readarr` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
Simply pulling `lscr.io/linuxserver/readarr:develop` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
@@ -65,7 +65,8 @@ This image provides various versions that are available via tags. Please read th
| Tag | Available | Description |
| :----: | :----: |--- |
| latest | ❌ | |
| nightly | ✅ | Nightly Readarr releases |
| develop | ✅ | Readarr releases from their develop branch |
| nightly | ✅ | Readarr releases from their nightly branch |
## Application Setup
@@ -90,7 +91,7 @@ Here are some example snippets to help you get started creating a container.
version: "2.1"
services:
readarr:
image: lscr.io/linuxserver/readarr
image: lscr.io/linuxserver/readarr:develop
container_name: readarr
environment:
- PUID=1000
@@ -118,7 +119,7 @@ docker run -d \
-v /path/to/books:/books `#optional` \
-v /path/to/downloadclient-downloads:/downloads `#optional` \
--restart unless-stopped \
lscr.io/linuxserver/readarr
lscr.io/linuxserver/readarr:develop
```
## Parameters
@@ -244,6 +245,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
## Versions
* **22.02.22:** - Add develop branch.
* **21.01.22:** - Rebase nightly branch to Alpine & deprecate nightly-alpine branch.
* **21.01.22:** - Remove chromaprint as it's no longer a required dependency.
* **01.01.22:** - Add chromaprint for audio fingerprinting.