From 2fa75d85d5ade332d7852b975a34d53fbc82c41a Mon Sep 17 00:00:00 2001 From: ze0s <43699394+zze0s@users.noreply.github.com> Date: Wed, 5 Apr 2023 21:12:51 +0200 Subject: [PATCH] docs: update README.md (#814) Update README with usenet etc. --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 344a175..c679b54 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ autobrr -

autobrr is the modern download automation tool for torrents. +

autobrr is the modern download automation tool for torrents and usenet. With inspiration and ideas from tools like trackarr, autodl-irssi and flexget we built one tool that can do it all, and then some.

GitHub release (latest by date) GitHub all releases GitHub Workflow Status

@@ -17,15 +17,17 @@ Installation guide and documentation can be found at https://autobrr.com ## Key features -- Support for 60+ trackers with IRC announces -- Torznab/RSS support via Prowlarr to easily get access to hundreds of trackers +- Torrents and usenet support +- Support for 70+ torrent trackers with IRC announces +- Newznab, Torznab and RSS support to easily get access to hundreds of torrent and usenet indexers +- Torrent Magnet support - Powerful but simple filtering with RegEx support (like in autodl-irssi) - Easy to use and mobile friendly web UI (with dark mode!) to manage everything - Built on Go and React making autobrr lightweight and perfect for supporting multiple platforms (Linux, FreeBSD, Windows, macOS) on different architectures (e.g. x86, ARM) - Great container support (Docker, k8s/Kubernetes) - Database engine supporting both PostgreSQL and SQLite - Notifications (Discord, Telegram, Notifiarr) -- One autobrr instance can communicate with multiple clients (both torrent and \*arr) on remote servers +- One autobrr instance can communicate with multiple clients (torrent, usenet and \*arr) on remote servers - Base path / Subfolder (and subdomain) support for convenient reverse-proxy support Available download clients and actions @@ -35,6 +37,7 @@ Available download clients and actions - rTorrent - Transmission - Sonarr, Radarr, Lidarr, Whisparr and Readarr (pushes releases directly to them and gets in the early swarm, instead of getting them via RSS when it's already over) +- SABnzbd (usenet) - Watch folder - Exec custom scripts - Webhook @@ -57,6 +60,12 @@ A lot of indexers do not announce new torrents in an IRC channel. You can still This isn't needed if your usecase is feeding the *arrs only. Since they have RSS support already. +### Usenet support + +Usenet support via Newzbab feeds allows you to easily manage everything in a single application. While there is a lot of applications that handles RSS well, we think autobrr offers very easy to use filtering to help you get the content you want. + +You can use Usenet feeds and send to arrs or send directly to SABnzbd. + ## Installation Full installation guide and documentation can be found at https://autobrr.com @@ -229,4 +238,4 @@ If you are not running a reverse proxy change `host` in the `config.toml` to `0. ## Community -Come join us on [Discord](https://discord.gg/WQ2eUycxyT)! \ No newline at end of file +Come join us on [Discord](https://discord.gg/WQ2eUycxyT)!