Start basic README.md

1 files changed, 39 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5ee45fc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+<h4 align="center">Watch videos with friends using WebRTC, do all your pausing and seek on the backend.</h4>
+
+<p align="center">
+  <a href="https://pion.ly"><img src="https://img.shields.io/badge/pion-webrtc-gray.svg?longCache=true&colorB=brightgreen" alt="Pion webrtc"></a>
+  <a href="https://pion.ly/slack"><img src="https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen" alt="Slack Widget"></a>
+  <br>
+  <a href="https://goreportcard.com/report/github.com/pion/rtwatch"><img src="https://goreportcard.com/badge/github.com/pion/rtwatch" alt="Go Report Card"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
+</p>
+<br>
+
+Using Pion WebRTC and GStreamer you can now watch videos in realtime with your friends. Watch your favorite movie perfectly synchronized with multiple viewers. If someone pauses it pauses for everyone, and no one can and no one fast forward only their video.
+
+*rtwatch* is different then any other solution because all state is stored on the backend. Only the current audio/video frame is being sent to the viewers, there is no way they can download/cache the videos either for future usage.
+
+## Instructions
+### Install GStreamer
+#### Debian/Ubuntu
+`sudo apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-plugins-good`
+#### Windows MinGW64/MSYS2
+`pacman -S mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-libav mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad mingw-w64-x86_64-gst-plugins-ugly`
+#### macOS
+` brew install gst-plugins-good pkg-config && export PKG_CONFIG_PATH="/usr/local/opt/libffi/lib/pkgconfig`
+
+### Download rtwatch
+```
+go get github.com/pion/rtwatch
+```
+
+### Play your video
+```
+rtwatch -container-path=/tmp/video.mp4
+> Video file '/tmp/output.mp4' is now available on ':8080', have fun!
+```
+
+### Watch your video with friends!
+Open [http://localhost:8080](http://localhost:8080) and hit play. Open it in multiple tabs so you can see how it syncs between multiple viewers.
+
+You also have the option to Seek/Play/Pause! Press those buttons and watch the video state change for every viewer at the same time.