Skip to content

Commit 79b42ca

Browse files
committed
Improve README — highlight killer features, add request workflow and scoring
1 parent 879aec1 commit 79b42ca

1 file changed

Lines changed: 18 additions & 5 deletions

File tree

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,31 @@
11
# Librarr
22

3-
Self-hosted book, audiobook, and manga search and download manager.
3+
**The missing *arr for books.** Self-hosted book, audiobook, and manga search and download manager — like Sonarr/Radarr but for your reading library.
44

5-
Librarr aggregates 13 search sources into a single interface, handles downloads via qBittorrent or SABnzbd, and automatically organizes files into your Calibre, Audiobookshelf, Kavita, or Komga libraries. It exposes a Torznab/Newznab API so it can act as an indexer in Prowlarr or Readarr, and an OPDS 1.2 feed for e-readers.
5+
Librarr searches 13 sources simultaneously, scores results by confidence, and auto-imports into your Calibre, Audiobookshelf, Kavita, or Komga library. Single 17MB Go binary. No runtime dependencies.
66

7+
### Highlights
8+
9+
- **Import your Goodreads/StoryGraph "to-read" list** via CSV and bulk-download everything
10+
- **Request workflow** — users request books, admins approve, downloads happen automatically (like Jellyseerr for books)
11+
- **Book metadata enrichment** — covers, descriptions, series info, and ISBN from Open Library
12+
- **Torznab API** — add Librarr as an indexer in Prowlarr or Readarr (it works both ways)
13+
- **13 search sources** — Anna's Archive, AudioBookBay, MangaDex, Nyaa, Open Library, Gutenberg, and more
14+
- **OPDS 1.2 feed** — browse your library from any e-reader
715

816
## Features
917

1018
- **13 search sources** in one UI (see table below)
19+
- **Search result scoring** — 0-100 confidence with breakdown (title match, author, format, seeders, size)
20+
- **Request/approval system** — users request → admin approves → auto-search + download + notification
21+
- **In-app notifications** — persistent alerts when downloads complete or fail
22+
- **Admin dashboard** — library stats, source health, activity log, bulk operations
23+
- **File uploads** — drag and drop ebooks/audiobooks, auto-organize + library scan
24+
- **4 download clients** — qBittorrent, SABnzbd, Deluge, Transmission with priority ordering
1125
- **Torznab/Newznab API** -- add Librarr as an indexer in Prowlarr, Readarr, or any Torznab-compatible app
1226
- **OPDS 1.2 feed** -- browse and download books from any e-reader or OPDS client
13-
- **Dual download clients** -- qBittorrent (torrents) and SABnzbd (Usenet/NZB) with configurable priority
14-
- **Post-download pipeline** -- organize files, import into Calibre/Audiobookshelf/Kavita/Komga, track in SQLite
15-
- **Torrent completion watcher** -- background goroutine polls qBittorrent, auto-imports completed downloads
27+
- **Post-download pipeline** -- organize files by author/title, import into Calibre/Audiobookshelf/Kavita/Komga
28+
- **Open Library metadata** — covers, descriptions, series, ISBN, publication year fetched automatically
1629
- **EPUB verification** -- checks title word overlap to detect wrong-book downloads
1730
- **Multi-user auth** -- session login with bcrypt passwords, TOTP 2FA, admin/user roles
1831
- **OIDC / SSO** -- OpenID Connect support for Authelia, Keycloak, Authentik, etc.

0 commit comments

Comments
 (0)