summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2020-05-18 06:00:17 +0200
committerSven Gothel <[email protected]>2020-05-18 06:00:17 +0200
commit82db617ba6d9d0be49c851320cffdb8b1d112b93 (patch)
tree181066ed0cfc053c8aaa5a3bdd0e4601f2f0706e /README.md
parent20bed4dae489ec3c1821eaed2d7fad9dc6f8f715 (diff)
Fix general Doxygen Documentation
- Ensure C++ namespace gets properly documented -- Added tinyb namespace doc in BluetoothAdapter.hpp (first file) -- Added direct_bt namespace doc in ATTPDUTypes.hpp (first file) Showing hierarchy and hinting to details and coverage. - Fix CMakeList for doc target and some doxygen config finetuning
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 9 insertions, 6 deletions
diff --git a/README.md b/README.md
index 8a2c8e00..407dc9af 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,20 @@
-Tiny Bluetooth LE Library
-=============
+Tiny Bluetooth LE Library / Direct-BT
+=====================================
Goals
============
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 and alternative implementations.
+TinyB exposes the BLE GATT API for C++, Java and other languages.
TinyB Version 2
-============
+================
+
+Starting with version 2.1.0, the specification has slightly changed and hence its implementation.
-Starting with version 2.0.0, the specification has slightly changed and hence its implementation.
+TinyB consist out of two implementations
+- TinyB using BlueZ over DBus
+- Direct-BT providing direct Bluetooth programming
Pre version 2.0.0 D-Bus implementation details of the Java[tm] classes
of package *tinyb* has been moved to *tinyb.dbus*.