Browse Source

Referenced Doc in Readme

Paul-Louis Ageneau 4 years ago
parent
commit
3013324e64
2 changed files with 3 additions and 1 deletions
  1. 2 0
      DOC.md
  2. 1 1
      README.md

+ 2 - 0
DOC.md

@@ -1,5 +1,7 @@
 # libdatachannel - C API Documentation
 
+The following details the C API of libdatachannel. The C API is available by including the rtc/rtc.h header.
+
 ### General considerations
 
 Unless stated otherwise, functions return `RTC_ERR_SUCCESS`, defined as `0`, on success.

+ 1 - 1
README.md

@@ -62,7 +62,7 @@ See [BUILDING.md](https://github.com/paullouisageneau/libdatachannel/blob/master
 
 See [examples](https://github.com/paullouisageneau/libdatachannel/blob/master/examples/) for complete usage examples with signaling server (under GPLv2).
 
-Additionnaly, you might want to have a look at the [C API](https://github.com/paullouisageneau/libdatachannel/blob/master/include/rtc/rtc.h).
+Additionnaly, you might want to have a look at the [C API documentation](https://github.com/paullouisageneau/libdatachannel/blob/master/DOC.md).
 
 ### Signal a PeerConnection