Browse Source

Updated Readme

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

+ 8 - 2
README.md

@@ -1,11 +1,15 @@
 # libdatachannel - C/C++ WebRTC DataChannels
 # libdatachannel - C/C++ WebRTC DataChannels
 
 
-libdatachannel is a simple implementation of WebRTC DataChannels in C++17 with C bindings. Its API is modelled as a simplified version of the JavaScript WebRTC API, in order to ease the design of cross-environment applications.
+libdatachannel is a standalone implementation of WebRTC DataChannels in C++17 with C bindings. It enables direct connectivity between native applications and web browsers without the pain of importing the entire WebRTC stack. Its API is modelled as a simplified version of the JavaScript WebRTC API, in order to ease the design of cross-environment applications.
 
 
 This projet is originally inspired by [librtcdcpp](https://github.com/chadnickbok/librtcdcpp), however it is a complete rewrite from scratch, because the messy architecture of librtcdcpp made solving its implementation issues difficult.
 This projet is originally inspired by [librtcdcpp](https://github.com/chadnickbok/librtcdcpp), however it is a complete rewrite from scratch, because the messy architecture of librtcdcpp made solving its implementation issues difficult.
 
 
 Licensed under LGPLv2, see [LICENSE](https://github.com/paullouisageneau/libdatachannel/blob/master/LICENSE).
 Licensed under LGPLv2, see [LICENSE](https://github.com/paullouisageneau/libdatachannel/blob/master/LICENSE).
 
 
+## 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.
+
 ## Dependencies
 ## Dependencies
 
 
 - libnice: https://github.com/libnice/libnice
 - libnice: https://github.com/libnice/libnice
@@ -23,6 +27,8 @@ make
 
 
 ## Example
 ## Example
 
 
+In the following examples, note the callbacks are called in another thread.
+
 ### Signal a PeerConnection
 ### Signal a PeerConnection
 
 
 ```cpp
 ```cpp
@@ -71,7 +77,7 @@ dc->onMessage([](const variant<binary, string> &message) {
 
 
 ```cpp
 ```cpp
 shared_ptr<rtc::DataChannel> dc;
 shared_ptr<rtc::DataChannel> dc;
-pc->onDataChannel([&dc](shared_ptr<rtc::DataChannel> incoming) {
+pc->onDataChannel([&dc](const shared_ptr<rtc::DataChannel> &incoming) {
     dc = incoming;
     dc = incoming;
     dc->send("Hello world!");
     dc->send("Hello world!");
 });
 });