summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2020-05-18 15:21:52 +0200
committerSven Gothel <[email protected]>2020-05-18 15:21:52 +0200
commitc57271b316805156a44243ddf96035888957f8a0 (patch)
treeb10ea55e779dbf4982b65bacb6364d9f9526b339 /README.md
parentd2aba7577f74408ee0a9a35d1a96c6f74dcd55a5 (diff)
README.md: Elaborate on both implementations a bit more, add direct link to Direct-BT C++ overview doc
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 22 insertions, 2 deletions
diff --git a/README.md b/README.md
index 7b03663e..c1a42bcd 100644
--- a/README.md
+++ b/README.md
@@ -13,9 +13,29 @@ TinyB Version 2
Starting with version 2.1.0, the specification has slightly changed and hence its implementation.
The TinyB project consist out of two implementations
-- *TinyB* using BlueZ over DBus, exposed as *libtinyb.so* and *libjavatinyb.so*
-- *Direct-BT* providing direct Bluetooth programming, exposed as *libdirect_bt.so* and *libjavadirect_bt.so*
+TinyB
+-----
+*TinyB* exposes the BLE GATT API for C++, Java and other languages, using BlueZ over DBus.
+
+*TinyB* is exposed via the following native libraries
+- *libtinyb.so* for the core C++ implementation.
+- *libjavatinyb.so* for the Java binding.
+
+Direct-BT
+----------
+*Direct-BT* provides direct Bluetooth programming without intermediate layers
+targeting high-performance reliable Bluetooth support.
+
+*TinyB* is exposed via the following native libraries
+- *libdirect_bt.so* for the core C++ implementation.
+- *libjavadirect_bt.so* for the Java binding.
+
+You will find a detailed overview of *Direct-BT* in the doxygen generated
+[C++ API doc of its *direct_bt* namespace](../../cpp/html/namespacedirect__bt.html#details).
+
+TinyB and Direct-BT
+-------------------
Pre version 2.0.0 D-Bus implementation details of the Java[tm] classes
of package *tinyb* has been moved to *tinyb.dbus*.
The *tinyb.jar* jar file has been renamed to *tinyb2.jar*, avoiding conflicts.