Browse Source

Updated Readme

Paul-Louis Ageneau 6 years ago
parent
commit
c50b055779
1 changed files with 6 additions and 6 deletions
  1. 6 6
      README.md

+ 6 - 6
README.md

@@ -8,7 +8,7 @@ Licensed under LGPLv2, see [LICENSE](https://github.com/paullouisageneau/libdata
 
 
 ## Compatibility
 ## Compatibility
 
 
-This implementation has been tested to be compatible with Firefox and Chromium. It supports Multicast DNS candidates resolution provided the operating system also supports it.
+This implementation has been tested to be compatible with Firefox and Chromium. It supports IPv6 and Multicast DNS candidates resolution provided the operating system also supports it.
 
 
 ## Dependencies
 ## Dependencies
 
 
@@ -21,13 +21,13 @@ Submodules:
 ## Building
 ## Building
 
 
 ```bash
 ```bash
-git submodule update --init --recursive
-make
+$ git submodule update --init --recursive
+$ make
 ```
 ```
 
 
 ## Example
 ## Example
 
 
-In the following example, notes the callbacks are called in another thread.
+In the following example, note the callbacks are called in another thread.
 
 
 ### Signal a PeerConnection
 ### Signal a PeerConnection
 
 
@@ -37,7 +37,7 @@ In the following example, notes the callbacks are called in another thread.
 
 
 ```cpp
 ```cpp
 rtc::Configuration config;
 rtc::Configuration config;
-config.iceServers.emplace_back("stunserver.org:3478");
+config.iceServers.emplace_back("mystunserver.org:3478");
 
 
 auto pc = make_shared<rtc::PeerConnection>(config);
 auto pc = make_shared<rtc::PeerConnection>(config);
 
 
@@ -81,7 +81,7 @@ dc->onMessage([](const variant<binary, string> &message) {
 
 
 ```cpp
 ```cpp
 shared_ptr<rtc::DataChannel> dc;
 shared_ptr<rtc::DataChannel> dc;
-pc->onDataChannel([&dc](const shared_ptr<rtc::DataChannel> &incoming) {
+pc->onDataChannel([&dc](shared_ptr<rtc::DataChannel> incoming) {
     dc = incoming;
     dc = incoming;
     dc->send("Hello world!");
     dc->send("Hello world!");
 });
 });