Added README

This commit is contained in:
Alexandros Schillings
2014-03-20 17:26:31 +00:00
parent df90eecdec
commit af22e1a7f7

49
README.md Normal file
View File

@@ -0,0 +1,49 @@
Bluetooth LE Library for Android
-----------
This library allows for easy access to a Bluetooth LE device's AdRecord.
Sample app available on the [Play Store](https://play.google.com/store/apps/details?id=uk.co.alt236.btlescan)
Basic Usage
-----------
There are two ways to use this library:
a. Download a copy of the ReflectiveDrawableLoader library and reference it in your project.
b. Create a Jar file (see Jarification below) and add it into your project.
Jarification
-----------
Type `ant jar` at the root of the Library Project to produce a Jar file.
Changelog
-----------
* v0.0.1 First public release
Permission Explanation
-----------
* No permissions required
Sample App Screenshots
-----------
![screenshot1](https://github.com/alt236/Reflective-Drawable-Loader---Android/raw/master/screenshots/screenshot_1.png)
![screenshot2](https://github.com/alt236/Reflective-Drawable-Loader---Android/raw/master/screenshots/screenshot_2.png)
Links
-----------
* Github: [https://github.com/alt236/Bluetooth-LE-Library---Android]()
Credits
-----------
Author: [Alexandros Schillings](https://github.com/alt236).
* The Accuracy calculation algorithm was taken from: http://stackoverflow.com/questions/20416218/understanding-ibeacon-distancing
* The AdRecord parser was taken from: https://github.com/devunwired/accessory-samples
All logos are the property of their respective owners.
The icons used for the example app were downloaded from here: [Android Design](http://developer.android.com/design/downloads/index.htm)
The code in this project is licensed under the Apache Software License 2.0.
Copyright (c) 2014 Alexandros Schillings.