You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Readarr/README.md

59 lines
3.9 KiB

# Readarr
[![Build Status](https://dev.azure.com/Readarr/Readarr/_apis/build/status/Readarr.Readarr?branchName=develop)](https://dev.azure.com/Readarr/Readarr/_build/latest?definitionId=1&branchName=develop)
[![Backers on Open Collective](https://opencollective.com/readarr/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/readarr/sponsors/badge.svg)](#sponsors)
### Readarr is in early stages of development, alpha/beta binary builds are not yet available. Use of any test builds isn't recommend, and may have detrimental effects on your library.
Readarr is a ebook (and maybe eventually magazine/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.
## Major Features Include:
* Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
* Automatically detects new books.
* Can scan your existing library and download any missing books.
* Automatic failed download handling will try another release if one fails
* Manual search so you can pick any release or to see why a release was not downloaded automatically
* Fully configurable book renaming
* Full integration with SABnzbd and NZBGet
* Full integration with Calibre (add to library, conversion)
* And a beautiful UI
## Support
[![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60)](https://discord.gg/WWd5ZGg)
[![GitHub](https://img.shields.io/badge/github-issues-red.svg?maxAge=60)](https://github.com/Readarr/Readarr/issues)
[![GitHub Wiki](https://img.shields.io/badge/github-wiki-181717.svg?maxAge=60)](https://github.com/Readarr/Readarr/wiki)
[![Docker Pulls](https://img.shields.io/docker/pulls/hotio/readarr)](https://hub.docker.com/r/hotio/readarr)
## Contributors
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/lidarr#backer)]
<a href="https://opencollective.com/readarr#backers" target="_blank"><img src="https://opencollective.com/readarr/backers.svg?width=890"></a>
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/readarr#sponsor)]
<a href="https://opencollective.com/readarr/sponsor/0/website" target="_blank"><img src="https://opencollective.com/readarr/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/readarr/sponsor/1/website" target="_blank"><img src="https://opencollective.com/readarr/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/readarr/sponsor/2/website" target="_blank"><img src="https://opencollective.com/readarr/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/readarr/sponsor/3/website" target="_blank"><img src="https://opencollective.com/readarr/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/readarr/sponsor/4/website" target="_blank"><img src="https://opencollective.com/readarr/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/readarr/sponsor/5/website" target="_blank"><img src="https://opencollective.com/readarr/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/readarr/sponsor/6/website" target="_blank"><img src="https://opencollective.com/readarr/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/readarr/sponsor/7/website" target="_blank"><img src="https://opencollective.com/readarr/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/readarr/sponsor/8/website" target="_blank"><img src="https://opencollective.com/readarr/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/readarr/sponsor/9/website" target="_blank"><img src="https://opencollective.com/readarr/sponsor/9/avatar.svg"></a>
### License
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
* Copyright 2010-2020