From 3013324e6448c376f0bf159160f1b2b3308d7dc4 Mon Sep 17 00:00:00 2001 From: Paul-Louis Ageneau Date: Fri, 12 Mar 2021 12:33:23 +0100 Subject: [PATCH] Referenced Doc in Readme --- DOC.md | 2 ++ README.md | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/DOC.md b/DOC.md index a9a63b7..f823f93 100644 --- a/DOC.md +++ b/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. diff --git a/README.md b/README.md index 812a602..6212e84 100644 --- a/README.md +++ b/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