commit 33e6d255a31acb88e4af06b3e128699d372a5b3d
Author: Brandon <bh@sigmagaming.net>
Date:   Wed Jun 12 14:22:05 2024 +0200

    Add README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c9a1e74
--- /dev/null
+++ b/README.md
@@ -0,0 +1,70 @@
+## What does this contain?
+
+Currently, the script will set up 6 containers:
+- gluetun       - A vpn container with automatic kill switch
+- prowlarr      - API support for torrent trackers
+- flaresolverr  - Proxy server to bypass Cloadflare protection
+- transmission   - Torrent client
+- radarr        - Downloads movies using a torrent client like Transmission
+- sonarr        - Downloads shows using a torrent client like Transmission
+- jellyseer     - Handles requests for movies and tv shows
+
+## Required software
+
+- `docker` and `docker-compose`
+
+## Installation
+
+- Clone or download the repository and place the project in a directory of your choice
+
+### Configuration
+
+- run `cp sample.env .env` and edit this `.env` file so it matches your needs
+- open `docker-compose.yaml` and edit the configuration of `gluetun` ([gluetun documentation](https://github.com/qdm12/gluetun/wiki/)):
+  - set `VPN_SERVICE_PROVIDER` to your provider
+  - set `VPN_TYPE` to either openvpn or wireguard
+  - set the remaining environment variables to your needs, for example the regions you want to use (check the gluetun documentation)
+
+#### Define the path of your movies and shows folders
+
+- Open `docker-compose.yaml` and look for `/path/to/movies:/movies` and `/path/to/tvseries:/tv`
+- Change the placeholder path to the left of `:` to the path where you want to save your media
+
+For example, if I had:
+```
+/mnt/storage/
+|- Movies/
+|- Shows/
+```
+
+The lines should look like `/mnt/storage/Movies` and `/mnt/storage/Shows`
+
+## Starting the containers
+
+You can start the containers using:
+- `autojellyfin.sh start`
+
+## Stopping the containers
+
+You can stop the containers using:
+- `autojellyfin.sh stop`
+
+## Updating the containers
+
+You can update the containers using:
+- `autojellyfin.sh update`
+- `autojellyfin.sh start`
+
+## Configuration
+
+Take a look at the prowlarr quickstart guide for instructions on how to set up prowlarr, sonarr, and radarr -> https://wiki.servarr.com/prowlarr/quick-start-guide
+
+## Services
+
+Here's a list of the services that you can use:
+- prowlarr: `http://<ip>:9696`
+- transmission: `http://<ip>:9091`
+- radarr: `http://<ip>:7878`
+- sonarr: `http://<ip>:8989`
+- jellyseer: `http://<ip>:5055`
+- jellyfin: `http://<ip>:8096`