Skip to content

Commit 1ffcea2

Browse files
docs: update the current list of features we offer (#1262)
* docs: update the current list of features we offer * docs: add the missing `)` Co-authored-by: Gauthier <mail@gauthierth.fr> * docs: use proper acronym case Co-authored-by: Gauthier <mail@gauthierth.fr> * docs: add the missing `)` Co-authored-by: Gauthier <mail@gauthierth.fr> --------- Co-authored-by: Gauthier <mail@gauthierth.fr>
1 parent ce1b39f commit 1ffcea2

File tree

2 files changed

+16
-14
lines changed

2 files changed

+16
-14
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,22 @@
1414
<a href="#contributors-"><img alt="All Contributors" src="https://img.shields.io/badge/all_contributors-63-orange.svg"/></a>
1515
<!-- ALL-CONTRIBUTORS-BADGE:END -->
1616

17-
**Jellyseerr** is a free and open source software application for managing requests for your media library.
18-
It is a fork of [Overseerr](https://github.com/sct/overseerr) built to bring additional support for [Jellyfin](https://github.com/jellyfin/jellyfin) & [Emby](https://github.com/MediaBrowser/Emby) media servers!
17+
**Jellyseerr** is a free and open source software application for managing requests for your media library. It integrates with the media server of your choice: [Jellyfin](https://jellyfin.org), [Plex](https://plex.tv), and [Emby](https://emby.media/). In addition, it integrates with your existing services, such as **[Sonarr](https://sonarr.tv/)**, **[Radarr](https://radarr.video/)**.
1918

2019
## Current Features
2120

22-
- Full Jellyfin/Emby/Plex integration including authentication with user import & management
23-
- Supports Movies, Shows and Mixed Libraries
24-
- Ability to change email addresses for smtp purposes
21+
- Full Jellyfin/Emby/Plex integration including authentication with user import & management.
22+
- Support for **PostgreSQL** and **SQLite** databases.
23+
- Supports Movies, Shows and Mixed Libraries.
24+
- Ability to change email addresses for SMTP purposes.
2525
- Easy integration with your existing services. Currently, Jellyseerr supports Sonarr and Radarr. More to come!
2626
- Jellyfin/Emby/Plex library scan, to keep track of the titles which are already available.
2727
- Customizable request system, which allows users to request individual seasons or movies in a friendly, easy-to-use interface.
2828
- Incredibly simple request management UI. Don't dig through the app to simply approve recent requests!
2929
- Granular permission system.
3030
- Support for various notification agents.
3131
- Mobile-friendly design, for when you need to approve requests on the go!
32-
33-
(Upcoming Features include: Multiple Server Instances, and much more!)
32+
- Support for watchlisting & blacklisting media.
3433

3534
With more features on the way! Check out our [issue tracker](https://github.com/fallenbagel/jellyseerr/issues) to see the features which have already been requested.
3635

docs/README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,34 @@ sidebar_position: 1
77

88
Welcome to the Jellyseerr Documentation.
99

10+
**Jellyseerr** is a free and open source software application for managing requests for your media library. It integrates with the media server of your choice: [Jellyfin](https://jellyfin.org), [Plex](https://plex.tv), and [Emby](https://emby.media/). In addition, it integrates with your existing services, such as **[Sonarr](https://sonarr.tv/)**, **[Radarr](https://radarr.video/)**.
11+
1012
## Features
1113

1214
- **Full Jellyfin/Emby/Plex integration**. Login and manage user access with Jellyfin/Emby/Plex.
1315
- **Syncs to your Jellyfin/Emby/Plex library** to show what titles you already have.
16+
- Supports Movies, Shows and Mixed Libraries.
1417
- **Integrates with Sonarr and Radarr**. With more services to come in the future.
18+
- Optionally set **Override rules** for requests to match with your defined conditions.
1519
- **Easy to use request system** allowing users to request individual seasons or movies in a friendly, clean UI.
1620
- **Simple request management UI**. Don't dig through the app to approve recent requests.
1721
- **Mobile-friendly design**, for when you need to approve requests on the go.
1822
- Granular permission system.
1923
- Localization into other languages.
20-
- Support for PostgreSQL and SQLite databases.
24+
- Support for **PostgreSQL** and **SQLite** databases.
25+
- Support for various notification agents.
26+
- Easily **Watchlist** or **Blacklist** media.
2127
- More features to come!
2228

2329
## Motivation
2430

25-
The primary motivation for starting this project was to add support for Jellyfin and Emby to Overseerr. As Overseerr is an incredibly performant and easy-to-use application, we wanted to bring that same experience to Jellyfin and Emby users. Thus, **Jellyseerr** was born.
26-
27-
This application is designed to be a **one-stop-shop** for all your media requests. It is designed to be a **simple, easy-to-use** application that allows users to request media to be added to your Jellyfin/Emby/Plex server.
31+
The primary motivation for starting Jellyseerr was to bring Jellyfin and Emby support to Overseerr. However, over time, **Jellyseerr** has evolved into its own distinct application with unique features. Designed as a one-stop shop for media requests, it offers a simple, easy-to-use experience for managing requests on Jellyfin, Emby, and Plex servers.
2832

2933
## We need your help!
3034

31-
[Jellyseerr](https://github.com/Fallenbagel/jellyseerr) is a fork of Overseerr, with a heavy focus on Jellyfin and Emby integration.
32-
[Overseerr](https://github.com/sct/overseerr) is an ambitious project where the original developers/contributors have already poured a lot of work into, and we wanted to build on top of that.
35+
[Jellyseerr](https://github.com/Fallenbagel/jellyseerr) is an ambitious project where developers/contributors poured a lot of work into, and that builds on top of [Overseerr](https://github.com/sct/overseerr). And we have a lot more to do as well.
3336

34-
We also have poured a lot of work into this project, and we have a lot more to do as well. We need your valuable feedback and help to find and fix bugs. Also, with Jellyseerr being an open-source project, anyone is welcome to contribute. We also encourage you to contribute to Overseerr as well.
37+
We value your feedback and support in identifying and fixing bugs to make Jellyseerr even better. As an open-source project, we welcome contributions from everyone. While Jellyseerr has diverged from Overseerr and evolved into its own unique application, we still encourage contributions to Overseerr, as it played a crucial role in inspiring what Jellyseerr has become today.
3538

3639
Contribution includes building new features, patching bugs, translating the application, or even just writing documentation.
3740

0 commit comments

Comments
 (0)