🎉 Release of add-on Readarr 0.1.0

This commit is contained in:
Community Hass.io Add-ons Bot 2024-01-13 16:48:02 +00:00
parent f883a5a8ac
commit 9a517465f7
7 changed files with 172 additions and 0 deletions

View file

@ -347,6 +347,19 @@ Movie organizer/manager for usenet and torrent users
[:books: Radarr add-on documentation][addon-doc-radarr]
### ✓ [Readarr][addon-readarr]
![Latest Version][readarr-version-shield]
![Supports armhf Architecture][readarr-armhf-shield]
![Supports armv7 Architecture][readarr-armv7-shield]
![Supports aarch64 Architecture][readarr-aarch64-shield]
![Supports amd64 Architecture][readarr-amd64-shield]
![Supports i386 Architecture][readarr-i386-shield]
Book Manager and Automation (Sonarr for Ebooks)
[:books: Readarr add-on documentation][addon-doc-readarr]
### ✓ [SABnzbd][addon-sabnzbd]
![Latest Version][sabnzbd-version-shield]
@ -643,6 +656,7 @@ on the correct GitHub repository matching the add-on.
- [Open an issue for the add-on: Plex Media Server][plex-issue]
- [Open an issue for the add-on: Prowlarr][prowlarr-issue]
- [Open an issue for the add-on: Radarr][radarr-issue]
- [Open an issue for the add-on: Readarr][readarr-issue]
- [Open an issue for the add-on: SABnzbd][sabnzbd-issue]
- [Open an issue for the add-on: SQLite Web][sqlite-web-issue]
- [Open an issue for the add-on: Spotify Connect][spotify-issue]
@ -915,6 +929,15 @@ SOFTWARE.
[radarr-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg
[radarr-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
[radarr-i386-shield]: https://img.shields.io/badge/i386-no-red.svg
[addon-readarr]: https://github.com/hassio-addons/addon-readarr/tree/v0.1.0
[addon-doc-readarr]: https://github.com/hassio-addons/addon-readarr/blob/v0.1.0/README.md
[readarr-issue]: https://github.com/hassio-addons/addon-readarr/issues
[readarr-version-shield]: https://img.shields.io/badge/version-v0.1.0-blue.svg
[readarr-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[readarr-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[readarr-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg
[readarr-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
[readarr-i386-shield]: https://img.shields.io/badge/i386-no-red.svg
[addon-sabnzbd]: https://github.com/hassio-addons/addon-sabnzbd/tree/v0.1.0
[addon-doc-sabnzbd]: https://github.com/hassio-addons/addon-sabnzbd/blob/v0.1.0/README.md
[sabnzbd-issue]: https://github.com/hassio-addons/addon-sabnzbd/issues

3
readarr/CHANGELOG.md Normal file
View file

@ -0,0 +1,3 @@
## Whats changed
🎉 Initial add-on release 🎉

102
readarr/DOCS.md Normal file
View file

@ -0,0 +1,102 @@
# Home Assistant Community Add-on: Readarr
Book Manager and Automation (Sonarr for Ebooks).
## Installation
The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Home Assistant add-on.
1. Click the Home Assistant My button below to open the add-on on your Home
Assistant instance.
[![Open this add-on in your Home Assistant instance.][addon-badge]][addon]
1. Click the "Install" button to install the add-on.
1. Start the "Readarr" add-on
1. Check the logs of the "Readarr" add-on to see if everything went well.
1. Click "OPEN WEB UI" to open the Readarr interface.
1. Complete the wizard shown on screen.
## Configuration
_This add-on does not require any configuration to run._
## Known issues and limitations
- This add-on does not support Home Assistant's Ingress feature (aka, the
toggle that puts an add-on in the Home Assistant sidebar).
There are too many variables to take into account to make this work properly,
and if we would, it would be very easy to break. You could consider using an
iframe panel instead.
## Changelog & Releases
This repository keeps a change log using [GitHub's releases][releases]
functionality.
Releases are based on [Semantic Versioning][semver], and use the format
of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented
based on the following:
- `MAJOR`: Incompatible or major changes.
- `MINOR`: Backwards-compatible new features and enhancements.
- `PATCH`: Backwards-compatible bugfixes and package updates.
## Support
Got questions?
You have several options to get them answered:
- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on
support and feature requests.
- The [Home Assistant Discord chat server][discord-ha] for general Home
Assistant discussions and questions.
- The Home Assistant [Community Forum][forum].
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
You could also [open an issue here][issue] GitHub.
## Authors & contributors
The original setup of this repository is by [Franck Nijhof][frenck].
For a full list of all authors and contributors,
check [the contributor's page][contributors].
## License
MIT License
Copyright (c) 2024 Franck Nijhof
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg
[addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=a0d7b954_readarr&repository_url=https%3A%2F%2Fgithub.com%2Fhassio-addons%2Frepository
[contributors]: https://github.com/hassio-addons/addon-readarr/graphs/contributors
[discord-ha]: https://discord.gg/c5DvZ4e
[discord]: https://discord.me/hassioaddons
[forum]: https://community.home-assistant.io/t/?u=frenck
[frenck]: https://github.com/frenck
[issue]: https://github.com/hassio-addons/addon-readarr/issues
[reddit]: https://reddit.com/r/homeassistant
[releases]: https://github.com/hassio-addons/addon-readarr/releases
[semver]: http://semver.org/spec/v2.0.0.html

25
readarr/README.md Normal file
View file

@ -0,0 +1,25 @@
# Home Assistant Community Add-on: Readarr
[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
Book Manager and Automation (Sonarr for Ebooks).
## About
[Readarr] is an ebook and audiobook collection manager for Usenet and BitTorrent
users. It can monitor multiple RSS feeds for new books from your favorite
authors and will grab, sort, and rename them. Note that only one type of a
given book is supported.
[Readarr]: https://readarr.com
[discord-shield]: https://img.shields.io/discord/330944238910963714.svg
[discord]: https://discord.gg/c5DvZ4e
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
[forum]: https://community.home-assistant.io/t/?u=frenck
[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
[release-shield]: https://img.shields.io/badge/version-v0.1.0-blue.svg
[release]: https://github.com/hassio-addons/addon-readarr/tree/v0.1.0

19
readarr/config.yaml Normal file
View file

@ -0,0 +1,19 @@
name: Readarr
version: 0.1.0
slug: readarr
description: Book Manager and Automation (Sonarr for Ebooks)
url: https://github.com/hassio-addons/addon-readarr/tree/main/README.md
codenotary: codenotary@frenck.dev
webui: http://[HOST]:[PORT:8787]
init: false
arch:
- aarch64
- amd64
- armv7
map:
- addon_config:rw
- share:rw
- media:rw
ports:
8787/tcp: 8787
image: ghcr.io/hassio-addons/readarr/{arch}

BIN
readarr/icon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

BIN
readarr/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB