Browse Source

Enhanced Readmes in examples

Paul-Louis Ageneau 4 years ago
parent
commit
b765cba3d2
3 changed files with 17 additions and 8 deletions
  1. 4 4
      examples/README.md
  2. 4 4
      examples/streamer/README.md
  3. 9 0
      examples/web/README.md

+ 4 - 4
examples/README.md

@@ -1,12 +1,12 @@
-# Examples for libdatachannel
+# libdatachannel - Examples
 
 This directory contains different WebRTC clients and compatible WebSocket + JSON signaling servers.
 
-- [client](client) uses libdatachannel to implement WebRTC Data Channels with WebSocket signaling
-- [web](web) contains an equivalent implementation for web browsers
+- [client](client) contains a native client to open Data Channels with WebSocket signaling using libdatachannel
+- [web](web) contains a equivalent JavaScript client for web browsers
+- [signaling-server-nodejs](signaling-server-nodejs) contains a signaling server in node.js
 - [signaling-server-python](signaling-server-python) contains a similar signaling server in Python
 - [signaling-server-rust](signaling-server-rust) contains a similar signaling server in Rust (see [lerouxrgd/datachannel-rs](https://github.com/lerouxrgd/datachannel-rs) for Rust wrappers)
-- [signaling-server-nodejs](signaling-server-nodejs) contains a similar signaling server in node.js
 
 - [media](media) is a copy/paste demo to send the webcam from your browser into gstreamer.
 - [streamer](streamer) streams h264 and opus samples to web browsers (signaling-server-python is required).

+ 4 - 4
examples/streamer/README.md

@@ -2,19 +2,19 @@
 
 This example streams H264 and opus<sup id="a1">[1](#f1)</sup> samples to the connected browser client.
 
-## Starting signaling server
+## Start a signaling server
 
 ```sh
 $ python3 ../signaling-server-python/signaling-server.py
 ```
 
-## Starting php
+## Start a web server
 
 ```sh
-$ php -S 127.0.0.1:8080
+$ python3 -m http.server --bind 127.0.0.1 8080
 ```
 
-Now you can open demo at [127.0.0.1:8080](127.0.0.1:8080).
+Now you can open the demo at [http://127.0.0.1:8080](http://127.0.0.1:8080).
 
 ## Arguments
 

+ 9 - 0
examples/web/README.md

@@ -0,0 +1,9 @@
+# libdatachannel - Equivalent JavaScript client
+
+Start a web server in this directory with:
+```sh
+$ python3 -m http.server --bind 127.0.0.1 8080
+```
+
+You can now open the web client at [http://127.0.0.1:8080](http://127.0.0.1:8080).
+