diff --git a/README.md b/README.md index 15c5f3bda..be9cd2263 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,30 @@ -# Overseerr +

+Overseerr +

+

+Overseerr CI +

-A thing for requesting things +**Overseerr** is a tool for managing requests for your media library. It integrates with existing services such as **Sonarr** and **Radarr**! -## Development +## Current Features + +- Full Plex integration. Login and manage user access with Plex! +- Integrates easily with your existing services. Currently Overseerr supports Sonarr and Radarr. More in the future! +- Syncs to your Plex library to know what titles you already have +- Complex request system that allows users to request individual seasons or movies in a friendly, easy to use UI +- Incredibly simple request management UI. Don't dig through the app to simply approve recent requests +- Mobile friendly design, for when you need to approve requests on the go! + +## In Development + +- A lot! + +## API Documentation + +- Coming soon + +## Contribution You can develop Overseer entirely in docker. Make sure you have [Docker Desktop](https://www.docker.com/products/docker-desktop) installed before continuing.