summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2018-07-09 14:58:13 +0300
committerYuval Adam <_@yuv.al>2018-07-09 14:58:13 +0300
commitd16188ece853a926d7bb09b27ff064e8a08f6798 (patch)
treeb7f976c75209327b70492f0adb6cb0d497640fa4 /README.md
parent795ee78abbe747dbc37bdb562d45fa476824abda (diff)
Expand README
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
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:
+
+ - <kbd>Space</kbd> - Play / Pause
+ - <kbd>q</kbd> - Quit
+
## License
[GPLv3](LICENSE)