From 117c2e791e30462602cfd47f72b61f2b5905195d Mon Sep 17 00:00:00 2001 From: Jamie Date: Mon, 18 Jan 2021 20:42:47 +0000 Subject: [PATCH] Update README.md --- README.md | 106 +++++++++++------------------------------------------- 1 file changed, 20 insertions(+), 86 deletions(-) diff --git a/README.md b/README.md index fdb90a5fc..8ba5f6f4c 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,25 @@ + ![](http://i.imgur.com/qQsN78U.png) ____ [![Discord](https://img.shields.io/discord/270828201473736705.svg)](https://discord.gg/Sa7wNWb) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/ombi.svg)](https://hub.docker.com/r/linuxserver/ombi/) -[![Github All Releases](https://img.shields.io/github/downloads/tidusjar/Ombi/total.svg)](https://github.com/tidusjar/Ombi) +[![Github All Releases](https://img.shields.io/github/downloads/tidusjar/Ombi/total.svg)](https://github.com/ombi-app/Ombi) [![firsttimersonly](http://img.shields.io/badge/first--timers--only-friendly-blue.svg)](http://www.firsttimersonly.com/) [![Crowdin](https://d322cqt584bo4o.cloudfront.net/ombi/localized.svg)](https://crowdin.com/project/ombi) [![Patreon](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://patreon.com/tidusjar/Ombi) [![Paypal](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://paypal.me/PlexRequestsNet) +# Welcome + +Ombi is your friendly media request tool, automatically syncs with your media with your media servers! +Don't worry, it's grandma friendly, and more importantly; has wife approval certification 😂 + +| Service | Stable | Develop +|----------|:---------------------------:|:----------------------------:| +| Build Status | [![Build status](https://ci.appveyor.com/api/projects/status/hgj8j6lcea7j0yhn/branch/master?svg=true)](https://ci.appveyor.com/project/tidusjar/requestplex/branch/master) | [![Build Status](https://dev.azure.com/tidusjar/Ombi/_apis/build/status/Ombi%20CI?repoName=Ombi-app%2FOmbi&branchName=develop)](https://dev.azure.com/tidusjar/Ombi/_build/latest?definitionId=18&repoName=Ombi-app%2FOmbi&branchName=develop) | [![Build Status](https://dev.azure.com/tidusjar/Ombi/_apis/build/status/Ombi%20CI?branchName=feature%2Fv4)](https://dev.azure.com/tidusjar/Ombi/_build/latest?definitionId=18&branchName=feature%2Fv4) +| Download |[![Download](http://i.imgur.com/odToka3.png)](https://github.com/tidusjar/Ombi/releases) | [![Download](http://i.imgur.com/odToka3.png)](https://ci.appveyor.com/project/tidusjar/requestplex/branch/develop/artifacts) | [![Download](http://i.imgur.com/odToka3.png)](https://github.com/ombi-app/ombi/releases) | + # Feature Requests Feature requests are handled on Feature Upvote. @@ -16,14 +27,13 @@ Search the existing requests to see if your suggestion has already been submitte (If a similar request exists, please vote, or add additional comments to the request) #### [![Feature Requests](https://cloud.githubusercontent.com/assets/390379/10127973/045b3a96-6560-11e5-9b20-31a2032956b2.png)](https://features.ombi.io) -___ -[![Twitter](https://img.shields.io/twitter/follow/tidusjar.svg?style=social)](https://twitter.com/intent/follow?screen_name=tidusjar) + -Follow me developing Ombi! + -[![Twitch](https://img.shields.io/badge/Twitch-Watch-blue.svg?style=flat-square&logo=twitch)](https://www.twitch.tv/tidusjar) + ___ @@ -31,23 +41,9 @@ ___
_**Note:** There is no longer an iOS app due to complications outside of our control._ -___ - -We also now have merch up on Teespring! -[EU Store](https://teespring.com/stores/ombi-eu) -[US Store](https://teespring.com/stores/ombi-us) - -___ - - -| Service | Stable | Develop | V4 | -|----------|:---------------------------:|:----------------------------:|:----------------------------:| -| Build Status | [![Build status](https://ci.appveyor.com/api/projects/status/hgj8j6lcea7j0yhn/branch/master?svg=true)](https://ci.appveyor.com/project/tidusjar/requestplex/branch/master) | [![Build status](https://ci.appveyor.com/api/projects/status/hgj8j6lcea7j0yhn/branch/develop?svg=true)](https://ci.appveyor.com/project/tidusjar/requestplex/branch/develop) | [![Build Status](https://dev.azure.com/tidusjar/Ombi/_apis/build/status/Ombi%20CI?branchName=feature%2Fv4)](https://dev.azure.com/tidusjar/Ombi/_build/latest?definitionId=18&branchName=feature%2Fv4) -| Download |[![Download](http://i.imgur.com/odToka3.png)](https://github.com/tidusjar/Ombi/releases) | [![Download](http://i.imgur.com/odToka3.png)](https://ci.appveyor.com/project/tidusjar/requestplex/branch/develop/artifacts) | [![Download](http://i.imgur.com/odToka3.png)](https://github.com/tidusjar/ombi.releases/releases) | # Features -Here are some of the features Ombi V3 has: -* Now working without crashes on Linux. +Here are some of the features Ombi has: * Lets users request Movies, Music, and TV Shows (whether it being the entire series, an entire season, or even single episodes.) * Easily manage your requests * Allows you to set specific users to automatically have requests approved and added to the relevant service (Sonarr/Radarr/Lidarr/Couchpotato etc) @@ -58,72 +54,16 @@ Here are some of the features Ombi V3 has: * Will show if the request is already on plex or even if it's already monitored. * Automatically updates the status of requests when they are available on Plex/Emby * Slick, responsive and mobile friendly UI -* Ombi will automatically update itself :) (YMMV) -* Very fast! - -### Integration -We integrate with the following applications: -* Plex Media Server -* Emby -* Jellyfin -* Sonarr V2 and V3 -* Radarr V2 -* Lidarr -* DogNzb -* Couch Potato - - -### Notifications -Supported notifications: -* Mobile -* SMTP Notifications (Email) -* Discord -* Slack -* Pushbullet -* Pushover -* Mattermost -* Telegram -* Gotify -* Twilio -* Webhook - -### The difference between Version 4 and 3 - -Over the last year, we focused on the main functions on Ombi, a complete rewrite while making it better, faster and more stable. -We have already done most of the work, but some features are still be missing in this first version. -We are planning to bring back these features in V3 but for now you can find a list below with a quick comparison of features between v4 and v3. - - -| Service | Version 4 (Beta) | Version 3 (Stable)| -|----------|:----------:|:----------:| -| Multiple Plex/Emby/Jellyfin Servers | Yes | Yes | -| Emby/Jellyfin & Plex support | Yes | Yes | -| Mono dependency | No | No | -| Plex OAuth support | Yes | Yes | -| Login page | Yes (brand new) | Yes | -| Discovery page | Yes (brand new) | No | -| Request a movie collection | Yes (brand new) | No | -| Auto Delete Available Requests | Yes (brand new) | No | -| Report issues | Yes | Yes | -| Notifications support | Yes | Yes | -| Custom Notification Messages | Yes | Yes | -| Sending newsletters | Yes | Yes | -| Send a Mass Email | Yes | Yes | -| SickRage | Yes | Yes | -| CouchPotato | Yes | Yes | -| DogNzb | Yes | Yes | -| Headphones | No | Yes | -| Lidarr | Yes | Yes | + # Preview -![Preview](http://i.imgur.com/Nn1BwAM.gif) +![Preview](https://i.imgur.com/Bz4fz3H.jpg) # Installation -[Installation Guide](https://github.com/tidusjar/Ombi/wiki/Installation) -[Here for Reverse Proxy Config Examples](https://github.com/tidusjar/Ombi/wiki/Reverse-Proxy-Examples) -[PlexGuide.com - Ombi Deployment & 101 Demonstration!](https://www.youtube.com/watch?v=QPNlqqkjNJw&feature=youtu.be) +[Installation Guide](https://docs.ombi.app/installation/) +[Here for Reverse Proxy Config Examples](https://docs.ombi.app/settings/reverse-proxy/) # Contributors @@ -139,9 +79,3 @@ If you feel like donating you can donate with the below buttons! [![Paypal](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://paypal.me/PlexRequestsNet) ### A massive thanks to everyone for all their help! - - -### Sponsors ### -- [JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools - - [ReSharper](http://www.jetbrains.com/resharper/) -- [BrowserStack](https://www.browserstack.com) for allowing us to use their platform for testing