Skip to content

Commit 55bc7db

Browse files
authored
move API docs
1 parent 1a6f46c commit 55bc7db

File tree

1 file changed

+23
-24
lines changed

1 file changed

+23
-24
lines changed

README.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,29 @@ a WebSocket Server and Client for Arduino based on RFC6455.
3131
- ATmega2560 with Ethernet Shield (ATmega branch)
3232
- ATmega2560 with enc28j60 (ATmega branch)
3333

34-
##### High Level API #####
34+
###### Note: ######
35+
36+
version 2.0 and up is not compatible with AVR/ATmega, check ATmega branch.
37+
38+
Arduino for AVR not supports std namespace of c++.
39+
40+
### wss / SSL ###
41+
supported for:
42+
- wss client on the ESP8266
43+
- wss / SSL is not natively supported in WebSocketsServer however it is possible to achieve secure websockets
44+
by running the device behind an SSL proxy. See [Nginx](examples/Nginx/esp8266.ssl.reverse.proxy.conf) for a
45+
sample Nginx server configuration file to enable this.
46+
47+
### ESP Async TCP ###
48+
49+
This libary can run in Async TCP mode on the ESP.
50+
51+
The mode can be activated in the ```WebSockets.h``` (see WEBSOCKETS_NETWORK_TYPE define).
52+
53+
[ESPAsyncTCP](https://github.com/me-no-dev/ESPAsyncTCP) libary is required.
54+
55+
56+
### High Level Client API ###
3557

3658
- `begin` : Initiate connection sequence to the websocket host.
3759
```
@@ -63,29 +85,6 @@ Where `WStype_t type` is defined as:
6385
} WStype_t;
6486
```
6587

66-
67-
###### Note: ######
68-
69-
version 2.0 and up is not compatible with AVR/ATmega, check ATmega branch.
70-
71-
Arduino for AVR not supports std namespace of c++.
72-
73-
### wss / SSL ###
74-
supported for:
75-
- wss client on the ESP8266
76-
- wss / SSL is not natively supported in WebSocketsServer however it is possible to achieve secure websockets
77-
by running the device behind an SSL proxy. See [Nginx](examples/Nginx/esp8266.ssl.reverse.proxy.conf) for a
78-
sample Nginx server configuration file to enable this.
79-
80-
### ESP Async TCP ###
81-
82-
This libary can run in Async TCP mode on the ESP.
83-
84-
The mode can be activated in the ```WebSockets.h``` (see WEBSOCKETS_NETWORK_TYPE define).
85-
86-
[ESPAsyncTCP](https://github.com/me-no-dev/ESPAsyncTCP) libary is required.
87-
88-
8988
### Issues ###
9089
Submit issues to: https://github.com/Links2004/arduinoWebSockets/issues
9190

0 commit comments

Comments
 (0)