8000 update README.md · robokoding/arduinoWebSockets@297e9ae · GitHub
[go: up one dir, main page]
Skip to content

Commit 297e9ae

Browse files
Links2004Links2004
committed
update README.md
1 parent e1e6280 commit 297e9ae

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

‎README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,35 @@
1-
# arduinoWebSockets
1+
WebSocket Server and Client for Arduino
2+
===========================================
23

3-
a WebSocket Server and Client for arduino based on RFC6455
4+
a WebSocket Server and Client for Arduino based on RFC6455.
5+
6+
##### Supported features of RFC6455 #####
7+
- text frame
8+
- binary frame
9+
- connection close
10+
- ping
11+
- pong
12+
13+
##### Not supported features of RFC6455 #####
14+
- continuation frame
15+
16+
##### Limitations #####
17+
- max input length is limited to the ram size and the ```WEBSOCKETS_MAX_DATA_SIZE``` define
18+
- max output length has no limit (the hardware is the limit)
19+
- Client send masked frames always with mask 0x00000000 (open todo)
20+
21+
##### Supported Hardware #####
22+
- ESP8266 [Arduino for ESP8266](https://github.com/Links2004/Arduino)
23+
- ATmega328 with Ethernet Shield (planed)
24+
- ATmega328 with enc28j60 (planed)
25+
- ATmega2560 with Ethernet Shield (planed)
26+
- ATmega2560 with enc28j60 (planed)
27+
28+
### Issues ###
29+
Submit issues to: https://github.com/Links2004/arduinoWebSockets/issues
30+
31+
### License and credits ###
32+
33+
The library is licensed under [LGPLv2.1](https://github.com/Links2004/arduinoWebSockets/blob/master/LICENSE)
34+
35+
[libb64](http://libb64.sourceforge.net/) written by Chris Venter. It is distributed under Public Domain see [LICENSE](https://github.com/Links2004/arduinoWebSockets/blob/master/src/libb64/LICENSE).

0 commit comments

Comments
 (0)
0