From 71bc90ef89f7517acb2505a2416cca6fa257d447 Mon Sep 17 00:00:00 2001 From: doookkie Date: Wed, 16 Mar 2022 12:34:37 -0400 Subject: [PATCH] Update README.md Change the README to more accurately reflect Jellyseerr. --- README.md | 137 +++--------------------------------------------------- 1 file changed, 7 insertions(+), 130 deletions(-) diff --git a/README.md b/README.md index 02c4a81a..1c945e67 100644 --- a/README.md +++ b/README.md @@ -2,156 +2,33 @@ Overseerr

-Overseerr Release -Overseerr CI -

-

-Discord -Docker pulls -Translation status -Language grade: JavaScript -GitHub - -All Contributors - +Discord

-**Overseerr** is a free and open source software application for managing requests for your media library. It integrates with your existing services, such as **[Sonarr](https://sonarr.tv/)**, **[Radarr](https://radarr.video/)**, and **[Plex](https://www.plex.tv/)**! +**Jellyseerr** is a free and open source fork of Overseerr for managing requests for your media library. It integrates with your existing services, such as **[Sonarr](https://sonarr.tv/)**, **[Radarr](https://radarr.video/)**, and **[Jellyfin](https://jellyfin.org/)**! ## Current Features -- Full Plex integration. Authenticate and manage user access with Plex! -- Easy integration with your existing services. Currently, Overseerr supports Sonarr and Radarr. More to come! -- Plex library scan, to keep track of the titles which are already available. +- Jellyfin support +- Easy integration with your existing services. Currently, Jellyseerr supports Sonarr and Radarr. +- Jellyfin library scan, to keep track of the titles which are already available. - Customizable request system, which allows users to request individual seasons or movies in a friendly, easy-to-use interface. - Incredibly simple request management UI. Don't dig through the app to simply approve recent requests! - Granular permission system. - Support for various notification agents. - Mobile-friendly design, for when you need to approve requests on the go! -With more features on the way! Check out our [issue tracker](https://github.com/sct/overseerr/issues) to see the features which have already been requested. +Check out our [issue tracker](https://github.com/Fallenbagel/jellyseerr/issues). ## Getting Started Check out our documentation for instructions on how to install and run Overseerr: -https://docs.overseerr.dev/getting-started/installation - -## Preview - - - ## Support -- Check out the [Overseerr Documentation](https://docs.overseerr.dev/) before asking for help. Your question might already be in the [FAQ](https://docs.overseerr.dev/support/faq). -- You can get support on [Discord](https://discord.gg/overseerr). -- You can ask questions in the Help category of our [GitHub Discussions](https://github.com/sct/overseerr/discussions). +- You can get support on [Discord](https://discord.gg/VpVnZ92yQK). - Bug reports and feature requests can be submitted via [GitHub Issues](https://github.com/sct/overseerr/issues). -## API Documentation - -Our documentation is built on every commit and hosted at https://api-docs.overseerr.dev - -You can also access the API documentation from your local Overseerr install at http://localhost:5055/api-docs - -## Community - -You can ask questions, share ideas, and more in [GitHub Discussions](https://github.com/sct/overseerr/discussions). - -If you would like to chat with other members of our growing community, [join the Overseerr Discord server](https://discord.gg/overseerr)! - -Our [Code of Conduct](https://github.com/sct/overseerr/blob/develop/CODE_OF_CONDUCT.md) applies to all Overseerr community channels. - -## Contributing - -You can help improve Overseerr too! Check out our [Contribution Guide](https://github.com/sct/overseerr/blob/develop/CONTRIBUTING.md) to get started. - -## Contributors ✨ - -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

sct

πŸ’» 🎨 πŸ€”

Alex Zoitos

πŸ’»

Brandon Cohen

πŸ’» πŸ“–

Ahreluth

🌍

KovalevArtem

🌍

GiyomuWeb

🌍

Angry Cuban

πŸ“–

jvennik

🌍

darknessgp

πŸ’»

salty

πŸš‡

Shutruk

🌍

Krystian Charubin

🎨

Kieron Boswell

πŸ’»

samwiseg0

πŸ’¬ πŸš‡

ecelebi29

πŸ’» πŸ“–

MārtiΕ†Ε‘ MoΕΎeiko

πŸ’»

mazzetta86

🌍

Paul Hagedorn

🌍

Shagon94

🌍

sebstrgg

🌍

Danshil Mungur

πŸ’» πŸ“–

doob187

πŸš‡

johnpyp

πŸ’»

Jakob Ankarhem

πŸ“– πŸ’» 🌍

Jayesh

πŸ’»

flying-sausages

πŸ“–

hirenshah

πŸ“–

TheCatLady

πŸ’» 🌍 πŸ“–

Chris Pritchard

πŸ’» πŸ“–

Tamberlox

🌍

David

πŸ’»

Douglas Parker

πŸ“–

Daniel Carter

πŸ’»

nuro

πŸ“–

α—ͺΡ”Ξ½ΞΉΞ· α—·Ο…Π½ΚŸ

πŸš‡

JonnyWong16

πŸ“–

Roxedus

πŸ“–

WoisWoi

🌍

HubDuck

🌍 πŸ“–

costaht

πŸ“– 🌍

Shjosan

🌍

kobaubarr

🌍

Ricardo GonzΓ‘lez

🌍

Torkil

🌍

Jagandeep Brar

πŸ“–

dtalens

🌍

Alex Cortelyou

πŸ’»

Jono Cairns

πŸ’»

DJScias

🌍

Dabu-dot

🌍

Jabster28

πŸ’»

littlerooster

🌍

Dustin Hildebrandt

πŸ’»

Bruno Guerreiro

🌍

Alexander NeuhΓ€user

🌍

Livio

🎨

tangentThought

πŸ’»

NicolΓ‘s Espinoza

πŸ’»
-