From 55bc7db7ad915833e2ce3e0fb6efe29942462fa3 Mon Sep 17 00:00:00 2001 From: Markus Date: Mon, 6 Mar 2017 19:16:26 +0100 Subject: [PATCH] move API docs --- README.md | 47 +++++++++++++++++++++++------------------------ 1 file changed, 23 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 18acacb..8936f6e 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,29 @@ a WebSocket Server and Client for Arduino based on RFC6455. - ATmega2560 with Ethernet Shield (ATmega branch) - ATmega2560 with enc28j60 (ATmega branch) -##### High Level API ##### +###### Note: ###### + + version 2.0 and up is not compatible with AVR/ATmega, check ATmega branch. + + Arduino for AVR not supports std namespace of c++. + +### wss / SSL ### + supported for: + - wss client on the ESP8266 + - wss / SSL is not natively supported in WebSocketsServer however it is possible to achieve secure websockets + by running the device behind an SSL proxy. See [Nginx](examples/Nginx/esp8266.ssl.reverse.proxy.conf) for a + sample Nginx server configuration file to enable this. + +### ESP Async TCP ### + +This libary can run in Async TCP mode on the ESP. + +The mode can be activated in the ```WebSockets.h``` (see WEBSOCKETS_NETWORK_TYPE define). + +[ESPAsyncTCP](https://github.com/me-no-dev/ESPAsyncTCP) libary is required. + + +### High Level Client API ### - `begin` : Initiate connection sequence to the websocket host. ``` @@ -63,29 +85,6 @@ Where `WStype_t type` is defined as: } WStype_t; ``` - -###### Note: ###### - - version 2.0 and up is not compatible with AVR/ATmega, check ATmega branch. - - Arduino for AVR not supports std namespace of c++. - -### wss / SSL ### - supported for: - - wss client on the ESP8266 - - wss / SSL is not natively supported in WebSocketsServer however it is possible to achieve secure websockets - by running the device behind an SSL proxy. See [Nginx](examples/Nginx/esp8266.ssl.reverse.proxy.conf) for a - sample Nginx server configuration file to enable this. - -### ESP Async TCP ### - -This libary can run in Async TCP mode on the ESP. - -The mode can be activated in the ```WebSockets.h``` (see WEBSOCKETS_NETWORK_TYPE define). - -[ESPAsyncTCP](https://github.com/me-no-dev/ESPAsyncTCP) libary is required. - - ### Issues ### Submit issues to: https://github.com/Links2004/arduinoWebSockets/issues