Diff: mbd_os/features/FEATURE_BLE/README.md

Revision:

0:eafc3fd41f75

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbd_os/features/FEATURE_BLE/README.md	Tue Sep 20 21:26:12 2016 +0000
@@ -0,0 +1,28 @@
+# mbed Bluetooth Low Energy Stack
+This is the Github repo for the `BLE_API` used by developer.mbed.org. Please see the [mbed BLE Homepage](https://developer.mbed.org/teams/Bluetooth-Low-Energy/) for all documentation, code examples and general help.
+
+# Supported Services
+Supported GATT services and constantly being added and can be found in the [ble/services/](https://github.com/ARMmbed/ble/tree/master/ble/services) folder.
+
+Currently supported services include:
+* Battery
+* Device Firmware Update (DFU)
+* Device Information
+* Eddystone Configuration Service
+* Health Thermometer
+* Heart Rate
+* Link Loss
+* UART
+* UriBeacon
+* iBeacon
+
+The [documentation](https://docs.mbed.com/docs/ble-intros/en/latest/AdvSamples/Overview/)
+contains an overview on how to create new, application-specific services.
+
+# 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 Homepage](https://developer.mbed.org/teams/Bluetooth-Low-Energy/) for all things BLE
+* [mbed BLE Getting Started Guide](https://developer.mbed.org/forum/team-63-Bluetooth-Low-Energy-community/topic/5262/) a wonderful primer on using BLE with mbed
+* [mbed BLE doc](https://docs.mbed.com/docs/ble-intros/en/latest/) for an introduction to mbed BLE
+* [mbed BLE API page](https://docs.mbed.com/docs/ble-api/en/latest/api/index.html) for the Doxygen API documentation