Permalink
Browse files

small doc update

  • Loading branch information...
1 parent 946fe10 commit 58ba0b040bec9953d398163f61a8b9f3b509e028 @jaz303 committed Aug 1, 2012
Showing with 2 additions and 2 deletions.
  1. +2 −2 README.mdown
View
4 README.mdown
@@ -70,15 +70,15 @@ We need to find a way to keep all special bytes from appearing on the wire save
0x5D # == 0x7D XOR 0x20
0x7E # message end
-By adding a final rule that only special bytes are ever escaped, we have a simple, reliable protocol for ensuring complete messages have been received<sup>*</sup>. To decode the resulting messages, all we need is a simple state machine to keep track of whether the next byte is escaped (and hence requires XOR decoding).
+By adding a final rule that only special bytes are ever escaped, we have a simple, reliable protocol for ensuring complete messages have been received<sup>*</sup>. To decode the resulting messages, all we need is a simple state machine to keep track of whether the next byte is escaped (and hence requires XOR decoding). It is this state machine that is implemented by `SerialBuffer`, along with a corresponding API for reading and writing messages.
<sup>*</sup> Actually, not quite - there could be still be data corruption within the message body. This is a higher-level concern; if data corruption is problem, use a checksum in your protocol.
## Installation
Either:
- * clone this repository into your Arduino library path OR
+ * clone this repository into your Arduino library path __or__
* create a `SerialBuffer` directory in your Arduino library path and copy `SerialBuffer.cpp` and `SerialBuffer.h` therein
## Example Sketch

0 comments on commit 58ba0b0

Please sign in to comment.