Skip to content

Commit d8e234b

Browse files
committed
Somewhat less Swenglish in the readme
1 parent 943a48f commit d8e234b

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
## Websocket Server for Arduino 1.0
22

3-
This is a simple library that implements a Websocket server running on an Arduino 1.0 or higher. The Websocket specification is still kind of a moving target. This implementation is based on the [proposed standard][1] published December 2011. This version has support by the current version (June 2012) of Firefox, Chrome, and Safari 6.0 beta (not older Safari, unfortunately) and thus is quite usable.
3+
This is a simple library that implements a Websocket server running on an Arduino 1.0 or higher. It's based on the [proposed standard][1] published December 2011 which is supported in the current versions (June 2012) of Firefox, Chrome, and Safari 6.0 beta (not older Safari, unfortunately) and thus is quite usable.
44

55
The implementation in this library has restrictions as the Arduino platform resources are very limited:
66

77
* The server **only** handles TXT frames.
88
* The server **only** handles **single byte** chars. The Arduino just can't handle UTF-8 to it's full.
99
* The server **only** accepts **final** frames with maximum payload length of 64 bytes. No fragmented data, in other words.
10-
* The server silently ignores all frames except TXT and CLOSE. This will most likely not be a problem for an Arduino based app.
10+
* For now, the server silently ignores all frames except TXT and CLOSE.
11+
* There's no keep-alive logic implemented.
1112

12-
_ Required headers (example):_
13+
_Required headers (example):_
1314

1415
GET /whatever HTTP/1.1
1516
Host: server.example.com
@@ -38,10 +39,14 @@ Try the supplied echo example together with the the [web based test client][2] t
3839

3940
Start playing with your own code and enjoy!
4041

42+
### Feedback
43+
44+
I'm a pretty lousy programmer, at least when it comes to Arduino, and it's been 15 years since I last touched C++, so do file issues for every opportunity for improvement.
45+
4146
Oh by the way, quoting myself:
4247

43-
> Don't forget to place a big ***fat*** disclaimer in the README. There is most certainly bugs in the code and I may well have misunderstood some things in the specification which I have only skimmed through and not slept with. So _please_ do not use this code in appliancies where people or pets could get hurt, like space shuttles, dog tread mills and Large Hadron Colliders.
48+
> Don't forget to place a big ***fat*** disclaimer in the README. There is most certainly bugs in the code and I may well have misunderstood some things in the specification which I have only skimmed through and not slept with. So _please_ do not use this code in appliancies where living things could get hurt, like space shuttles, dog tread mills and Large Hadron Colliders.
4449
4550

4651
[1]: http://datatracker.ietf.org/doc/rfc6455/?include_text=1 "Protol version implemented here"
47-
[2]: http://www.websocket.org/echo.html "Test client"
52+
[2]: http://www.websocket.org/echo.html "Echo Test client"

0 commit comments

Comments
 (0)