From 3d2a8cc4dda6ff4ca3b70877ab9e7203651d0e4b Mon Sep 17 00:00:00 2001 From: Nic Holthaus Date: Fri, 13 Apr 2018 13:01:44 -0400 Subject: [PATCH] doc updates --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a5f1180..1aa11f8 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ # win-bluetooth -A set of modern c++ classes for using bluetooth on windows +A set of modern c++ classes for using bluetooth on windows. Based on the Qt Bluetooth interface. C++17. -This library is still a work in progress. +[![Windows build](https://ci.appveyor.com/api/projects/status/5ym4bmwl8fbutgrl?svg=true&branch=master)](https://ci.appveyor.com/project/nholthaus/win-bluetooth) ![license](https://img.shields.io/badge/license-MIT-orange.svg) ![copyright](https://img.shields.io/badge/%C2%A9-Nic_Holthaus-orange.svg) ![language](https://img.shields.io/badge/language-c++-blue.svg) ![c++](https://img.shields.io/badge/std-c++17-blue.svg) ![msvc2017](https://img.shields.io/badge/MSVC-2017-ff69b4.svg) -The intent is to create a bluetooth library using Qt and winsock to fill the capability gap in Qt 5.10. Class APIs by design will be similar/identical to their Qt counterparts, and a user familiar with QtBluetooth should be able to use win-bluetooth without (much of) a learning curve. +# Follows the Qt Bluetooth class interface +The intent is to create a bluetooth library using Qt and winsock to fill the capability gap in Qt 5.10. Class APIs by design will be similar/identical to their Qt counterparts, and a user familiar with QtBluetooth should be able to use win-bluetooth without (much of) a learning curve. + +win-bluetooth uses the same class structure, just without the `Q` to start the class names. E.g. the equivalent for `QBluetoothSocket` would be `BluetoothSocket`. + +[Qt Bluetooth Documentation](http://doc.qt.io/qt-5/qtbluetooth-module.html) ## How to run the tests To tun the unit tests, you will need two windows PC's with bluetooth capability in range of each other. We'll call them the "server" PC and the "client" PC.