summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChris Hiszpanski <chris.hiszpanski@verkada.com>2022-05-21 01:04:33 -0700
committerChris Hiszpanski <chris.hiszpanski@verkada.com>2022-05-21 02:01:54 -0700
commit12df87e791ee6e468df31a6c468595b8c124a2b4 (patch)
treeb3eea9989ed5412383ed9912bdaac3fb1412b570 /README.md
Bare bones demo
* ICE candidate parser * Simple demo.html * Outline of tinyrtc.h
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/