diff --git a/README.md b/README.md index 7e577e7..75167e5 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,16 @@ ### Information: -This folder contains the compose and config files for all media server utilities +This is hopefully a comprehensive stack for the automated Jellyfin server. + +It contains all of the needed containers for the server hosting, download managers, indexers, and vpns + +### Instructions: + +- copy the `docker-compose.yml` and `example.env` to your chosen directory (preferably `~/docker/media_server`) +- rename `example.env` to `.env`, fill out the needed fields for the media mapping and vpn settings +- run `docker compose up -d` + ### Services: