Browse Source

Added mention of options NO_MEDIA and NO_WEBSOCKET

Paul-Louis Ageneau 4 years ago
parent
commit
7bda5bd77c
1 changed files with 4 additions and 0 deletions
  1. 4 0
      README.md

+ 4 - 0
README.md

@@ -73,6 +73,8 @@ $ git submodule update --init --recursive
 
 
 The CMake library targets `libdatachannel` and `libdatachannel-static` respectively correspond to the shared and static libraries. The default target will build tests and examples. The option `USE_GNUTLS` allows to switch between OpenSSL (default) and GnuTLS, and the option `USE_NICE` allows to switch between libjuice as submodule (default) and libnice.
 The CMake library targets `libdatachannel` and `libdatachannel-static` respectively correspond to the shared and static libraries. The default target will build tests and examples. The option `USE_GNUTLS` allows to switch between OpenSSL (default) and GnuTLS, and the option `USE_NICE` allows to switch between libjuice as submodule (default) and libnice.
 
 
+If you only need Data Channels, the option `NO_MEDIA` allows to make the library lighter by removing media support. Similarly, `NO_WEBSOCKET` removes WebSocket support.
+
 #### POSIX-compliant operating systems (including Linux and Apple macOS)
 #### POSIX-compliant operating systems (including Linux and Apple macOS)
 ```bash
 ```bash
 $ cmake -B build -DUSE_GNUTLS=1 -DUSE_NICE=0
 $ cmake -B build -DUSE_GNUTLS=1 -DUSE_NICE=0
@@ -121,6 +123,8 @@ $ nmake
 
 
 The option `USE_GNUTLS` allows to switch between OpenSSL (default) and GnuTLS, and the option `USE_NICE` allows to switch between libjuice as submodule (default) and libnice.
 The option `USE_GNUTLS` allows to switch between OpenSSL (default) and GnuTLS, and the option `USE_NICE` allows to switch between libjuice as submodule (default) and libnice.
 
 
+If you only need Data Channels, the option `NO_MEDIA` removes media support. Similarly, `NO_WEBSOCKET` removes WebSocket support.
+
 ```bash
 ```bash
 $ make USE_GNUTLS=1 USE_NICE=0
 $ make USE_GNUTLS=1 USE_NICE=0
 ```
 ```