diff --git a/README.md b/README.md index be9cd2263..661650702 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@

Overseerr CI +Discord +Docker pulls +Translation

**Overseerr** is a tool for managing requests for your media library. It integrates with existing services such as **Sonarr** and **Radarr**! @@ -11,14 +14,29 @@ - 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 +- 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! +- Full request page that gives you more refined control and details. +- Actor page with movies/shows they have been in. +- Ability to sync users from your Plex with Overseerr. + +## Planned Features + +- A more advanced notification system supporting a lot more apps such as slack/telegram/etc. + +## Preview + + + +## Support + +- You can reach us for support on [Discord](https://discord.gg/ySfaEUcQ). +- Bugs can be opened with an issue on [Github](https://github.com/sct/overseerr/issues). ## API Documentation @@ -29,7 +47,7 @@ You can develop Overseer entirely in docker. Make sure you have [Docker Desktop](https://www.docker.com/products/docker-desktop) installed before continuing. 1. Make sure you have [Docker Desktop](https://www.docker.com/products/docker-desktop) installed. -2. Run `docker-compose up -d` to start the server +2. Run `docker-compose up -d` to start the server. 3. Access the container at http://localhost:3000 That's it! diff --git a/public/preview.png b/public/preview.png new file mode 100644 index 000000000..7d90433e3 Binary files /dev/null and b/public/preview.png differ