Updated README.md and added CHANGELOG.md

Author: basilfx

CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+## v2.0.0
+Released 17 September 2015
+
+Highlights:
+* Added: Python 3.4 support.
+* Improved: More strict handling of bytes.
+* Improved: Formatted code according to PEP8.
+* Changed: ResetFrame is now a Frame, with correct flags set.
+* Changed: DamagedFrame is now a property on a Frame.
+
+The full list of commits can be found [here](https://github.com/basilfx/python-tinylink/compare/v1.1.0...v2.0.0).
+
+## v1.1.0
+Released 01 December 2014
+
+The full list of commits can be found [here](https://github.com/basilfx/python-tinylink/compare/v1.0.0...v1.1.0).
+
+## v1.0.0
+Released 07 October 2014
+
+The full list of commits can be found [here](https://github.com/basilfx/python-tinylink/compare/76afcbd301ca3ec4c58e232a10a7547a1e4ce982...v1.0.0).

README.md

@@ -1,10 +1,12 @@
 # python-tinylink
 Frame-based streaming protocol for embedded applications.
 
+[![Build Status](https://travis-ci.org/basilfx/python-tinylink.svg?branch=master)](https://travis-ci.org/basilfx/python-tinylink)
+
 ## Introduction
 This is a general purpose Python module to provide a bi-directional frame-based streaming protocol for low-speed embedded applications, such as serial connected devices. It allowes the receiver to 'jump into' a stream of data frames. Every frame starts with a preamble, so the receiver can synchronize. Any mismatch in checksum will the receiver.
 
-A payload is optional. The reserved `RESET` flag can be used to indicate that the link should reset, for instance when the receiver just started and the sender should restart.
+A payload is optional.
 
 The format of a frame is as follows:
 
@@ -20,20 +22,28 @@ X = Body payload (max. 65536 bytes)
 Y = CRC32 checksum over header + body
 ```
 
+The flags field can have arbitrary values, but the following flags are reserved.
+
+* `0x01 = RESET`
+* `0x02 = ERROR`
+* `0x04 = PRIORITY`
+
 Error correction is not implemented and the bytes are not aligned. The endianness is customizable.
 
-## Statechart diagram
+## State chart diagram
 Below is a simplified statechart diagram of the receiver.
 ![Alt text](docs/statechart.png)
 
 ## Installation
 The latest development version can be installed via `pip install git+https://github.com/basilfx/python-tinylink`.
 
 ## Tests
-Tests can be executed with `nose`. Check the `tests/` folder for more information.
+Tests can be executed with `nosetests`. Check the `tests/` folder for more information.
 
 ## CLI
 A simple serial CLI is included. When installed, run `tinylink /dev/tty.PORT_HERE` to start it. You can use it to send raw bytes via the link and display what comes back.
 
+PySerial is required to run this CLI.
+
 ## License
-See the `LICENSE` file (MIT license).
+See the `LICENSE` file (MIT license).