From d16188ece853a926d7bb09b27ff064e8a08f6798 Mon Sep 17 00:00:00 2001 From: Yuval Adam <_@yuv.al> Date: Mon, 9 Jul 2018 14:58:13 +0300 Subject: Expand README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 5acd306..d13116c 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,27 @@ The `r` stands for Rust. - [ ] Add subtitles to the video - [ ] Integrate with ffmpeg to do on the fly transcoding +## Usage + +Make sure you have a UPnP streamer online on your local network, then run: + +```bash +$ slingr ~/path/to/media.file +``` + +To target a specific device: + +```bash +$ slingr --device 192.168.33.44 ~/path/to/media.file +``` + +### Controls + +During playback use the following controls: + + - Space - Play / Pause + - q - Quit + ## License [GPLv3](LICENSE) -- cgit v1.3.1