diff --git a/README.md b/README.md index 984b7af..1ef8055 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,12 @@ `svr` is a utility that monitors and downloads livestreams for any site with a youtube-dl extractor. -Example `config.toml`: +## Example CLI Usage +```bash +svr -c /path/to/config.toml +``` + +## Example `config.toml`: ```toml output = "/media/livestreams" @@ -25,6 +30,17 @@ url = "https://www.youtube.com/watch?v=jfKfPfyJRdk" frequency = "2h" ``` +## Example `docker-compose.yml`: +```yaml +svr: + container_name: svr + image: git.nickzana.dev/nick/svr:latest + volumes: + - $CONFIG/config.toml:/config.toml + - $MEDIA_PATH/livestreams:/media/livestreams + restart: unless-stopped +``` + ## TODO - More configuration options for individual streams - Handle server/stream interruptions (e.g. merging multiple stream files) @@ -32,4 +48,4 @@ frequency = "2h" - Automatic deletion after e.g. a period of time - Improved logging (tracing?) - Save metadata somewhere -- Improve cli docs +- Add --help menu