chore: add 'stream' option

README.md

@@ -13,7 +13,18 @@ Available Arguments:
 
     screen [slave-address]          Stream your current screen. Useful for streaming from a browser.
 
+    file [slave-address] [file]     Stream a file. Use for media that is saved locally.
 
-    file [slave-address]        Stream a file. Use for media that is saved locally.
+    stream [slave-address] [url]    Just tell the slave to listen for an already existing stream on the network.
 
 ```
+## Dependencies
+- [VLC](https://www.videolan.org/vlc) for streaming and receiving the stream
+- [bash](https://www.gnu.org/software/bash/) for running the client script
+- [curl](https://curl.se/) for the request from client to server
+
+## Installation
+1. Place the server executable on your server and create a [systemd service](https://www.freedesktop.org/software/systemd/man/latest/systemd.service.html) for it.
+2. Copy the `vlcstream` script to your client(s)
+3. Ensure your client and server are on the same network
+4. Run script with the address of your server

vlcstream

@@ -5,9 +5,10 @@ Available Arguments:
 
     screen [slave-address]          Stream your current screen. Useful for streaming from a browser.
 
+    file [slave-address] [file]     Stream a file. Use for media that is saved locally.
 
-    file [slave-address]        Stream a file. Use for media that is saved locally.
-"
+    stream [slave-address] [url]    Tell the slave to listen for an already existing stream on the network.
+    "
 
 err() {
     echo "❌ Error: $1";
@@ -21,12 +22,16 @@ fi
 
 if [ "$#" -eq "2" ]; then
     case $1 in
+        # use local vlc to create a stream of the current screen
         screen)
             #TODO
         ;;
+        # use local vlc to create a stream from a file
         file)
             #TODO
         ;;
+        # just pass a URL to a stream that should be opened by the vlc slave
+        stream)
         *)
             err "Illegal Argument";
             exit 2;