adding initial readme with references to developer.mbed.org

This commit is contained in:
Austin Blackstone 2014-11-13 13:18:41 -06:00
parent 039fd060ad
commit 5ff054e23b

18
README.md Normal file
View file

@ -0,0 +1,18 @@
# mbed Bluetooth Low Energy Stack
This is the github repo for the BLE_API used by developer.mbed.org . The BLE stack is under development and constantly evolving. For up to date documentation please see [the mbed BLE Documentation page](http://developer.mbed.org/teams/Bluetooth-Low-Energy/code/BLE_API/docs/tip/).
# Supported Services
Supported GATT services and constantly being added and can be found in the /services folder.
Currently supported services include:
* Battery
* Device Firmware Update (DFU)
* Device Information
* Health Thermometer
* Heart Rate
* UART
# Getting Started
The mbed BLE API is meant to be used in projects on developer.mbed.org. Please see examples and sample project files there.
A good starting point are these pages:
* [mbed BLE API](developer.mbed.org/teams/Bluetooth-Low-Energy/)
* [mbed BLE Getting Started Guide](http://developer.mbed.org/forum/team-63-Bluetooth-Low-Energy-community/topic/5262/)