From 8979ff41945fc1bbb6e76c9a672e4a73d1f0c124 Mon Sep 17 00:00:00 2001 From: Brendan Le Foll Date: Fri, 16 May 2014 10:07:28 +0100 Subject: [PATCH] README.md: add changelog to explain API changes Signed-off-by: Brendan Le Foll --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index d63fc60..b2cf042 100644 --- a/README.md +++ b/README.md @@ -54,3 +54,14 @@ see examples/ NODE_PATH=.* Python html documentation can be generated with **make pydoc** + +## API Changelog + +When the API breaks in a small way there will be a changelog listed here + +**0.2.3** + * maa_aio_read_u16() -> maa_aio_read() + * maa_aio_read() now returns a uint16_t instead of an unsigned int + +**0.2.2** + * First version with API considered 'stable'