summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..095d825
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+TinyRTC
+=======
+
+A header-only implementation of WebRTC for small systems like IP cameras
+
+Build
+-----
+
+ make
+
+Running
+-------
+
+The demo uses stdin/stdout for signaling, with one message per line.
+The excellent [websocketd](https://websocketd.com) utility wraps stdin/stdout
+into a websocket. Run:
+
+ websocketd --port=8080 --staticdir=example ./example/webrtcd
+
+Then visit:
+
+ http://localhost:8080/