diff options
author | Petre Eftime <[email protected]> | 2016-04-27 18:38:17 +0300 |
---|---|---|
committer | Petre Eftime <[email protected]> | 2016-04-27 18:38:17 +0300 |
commit | 5149de5fdb9e96d4db626d069a86f17f8c83df48 (patch) | |
tree | 0a27e4964135d92fddea955455c6918b4862e303 /README.md | |
parent | a99cba2755935b01c80cbd7b83eba3a6d788d5d6 (diff) |
Add links to API documentation
Signed-off-by: Petre Eftime <[email protected]>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 17 |
1 files changed, 14 insertions, 3 deletions
@@ -1,11 +1,22 @@ -Tiny Bluetooth Library +Tiny Bluetooth LE Library ============= [![Build Status](https://travis-ci.org/intel-iot-devkit/tinyb.svg?branch=master)](https://travis-ci.org/intel-iot-devkit/tinyb) [![Coverity Scan](https://scan.coverity.com/projects/7546/badge.svg)](https://scan.coverity.com/projects/intel-iot-devkit-tinyb) -This project aims to create clean, modern and easy to use Bluetooth GATT API -for C++, Java and other languages, using BlueZ over DBus. +This project aims to create clean, modern and easy to use Bluetooth LE API. +TinyB exposes the BLE GATT API for C++, Java and other languages, using BlueZ +over DBus. + +API Documentation +============ + +Up to date API documentation can be found: +* for C++: http://iotdk.intel.com/docs/master/tinyb/ +* for Java: http://iotdk.intel.com/docs/master/tinyb/java/ + +A guide for getting started with TinyB on Java is available here: +https://software.intel.com/en-us/java-for-bluetooth-le-apps. Using TinyB ============ |