mraa: update to version 0.5.1

[contrib/mraa.git] / docs / index.md

diff --git a/docs/index.md b/docs/index.md
index 964ff6d..d85de5b 100644 (file)
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,8 +1,8 @@
-MRAA - Low Level Skeleton Library for Communication on Intel platforms
+libmraa - Low Level Skeleton Library for Communication on Intel platforms
 ==============
 
 Library in C/C++ to interface with Galileo & other Intel platforms, in a
-structured and sane API with port nanmes/numbering that match boards & with
+structured and sane API with port names/numbering that match boards & with
 bindings to javascript & python.
 
 The intent is to make it easier for developers and sensor manufacturers to map
@@ -16,14 +16,15 @@ classes directly wrap the C API and provide a near 1:1 mapping of
 functionality.
 
 <center>
-| C API Modules          | C++ API Classes             |
-|:----------------------:|:---------------------------:|
+| C API Modules          | C++ API Classes              |
+|:----------------------:|:----------------------------:|
 | @ref gpio.h "gpio"     | @ref mraa::Gpio "Gpio class" |
 | @ref i2c.h "i2c"       | @ref mraa::I2c "I2c class"   |
 | @ref aio.h "aio"       | @ref mraa::Aio "Aio class"   |
 | @ref pwm.h "pwm"       | @ref mraa::Pwm "Pwm class"   |
 | @ref spi.h "spi"       | @ref mraa::Spi "Spi class"   |
-| @ref common.h "common" | @ref common.h "common"      |
+| @ref uart.h "uart"     | @ref mraa::Uart "Uart class" |
+| @ref common.h "common" | @ref mraa "common"           |
 </center>
 
 ### Hello Mraa
@@ -34,6 +35,8 @@ functionality.
 Specific platform information for supported platforms is documented here:
 
 - @ref galileorevd
+- @ref galileorevh
+- @ref edison
 
 ### ENV RECOMENDATIONS
 
@@ -47,11 +50,12 @@ cmake, libm and pthreads are technically required to compile.
 
 ## COMPILING
 
-More information on compiling is @ref building page
+More information on compiling is @ref building page.
 
 ## CONTRIBUTING
 
-Please see the @ref contributing page
+Please see the @ref contributing page, the @ref internals page may also be of
+use.
 
 ## API Changelog
 
@@ -59,6 +63,52 @@ This changelog is meant as a quick & rough guide to what has changed between
 versions. The API is now fairly stable but when new calls/features are added
 they are listed here. Anything pre 0.2.x is ignored.
 
+**0.5.1**
+  * Intel Edison - Mini breakout board support
+  * Change to use syslog throughout instead of printing to stderr.
+  * Fix misc issues brought up throuh coverity scans
+  * Clear up Analog call documentation
+
+**0.5.0**
+  * Intel Edison - Arduino board support.
+  * Boost Allowable i2c busses to 12
+  * Additional platform hooks added
+  * ADC is now 10bits by default on all platforms but can be changed
+
+**0.4.5**
+  * if only one spidev we default to it reguardless of number
+  * mraa_pwm_config_ms & mraa_pwm_config_percent functions added
+  * Uart C++ class added, adds python & node support
+  * galileo gen2 gpio modes supported
+
+**0.4.4**
+  * prefix SPI mode with MRAA_SPI_
+  * added C++ adc bitness calls
+
+**0.4.3**
+  * SPI Mode function now functional, API Change in SPI
+  * I2C read in swig worked on.
+  * Galileo Gen 2: PWM setting period sets all channel's period
+  * Galileo Gen 2: I2C setup now specific to Gen 2.
+  * General commits around freeing memory at the right times.
+
+**0.4.2**
+  * Barebone UART module added.
+  * Hook branch merged.
+  * I2C init hooks added.
+  * Intel Galileo Gen 2, I2C gpio pins now go hiz input when I2C initialised.
+
+**0.4.1**
+  * Rename python & nodejs modules to mraa
+  * common.hpp introduced for C++
+  * python & nodejs modules can now take binary strings for Spi & I2c
+  * improved Aio module and clear bitness
+  * Improved Galileo Gen 2 support
+
+**0.4.0**
+  * Rename to mraa
+  * get_platform_type function added.
+
 **0.3.1**
   * Initial Intel Galileo Gen 2 support
   * mraa_gpio_isr parameters added.