From 0f3618f167d7de5ed6b148a5867f0f01dbd0dcee Mon Sep 17 00:00:00 2001 From: Ian Channing Date: Sun, 14 Apr 2024 15:33:38 +0200 Subject: [PATCH 1/3] Pre-requisites section - Move the compatibility section to the top. - Explicitly mention that Windows and Mac OS are not supported - Mention `apt` install --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c483254..e366eff 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,19 @@ Bluetooth Low Energy (BLE) library written with pure Node.js (no bindings) - bak - [GattService](https://github.com/chrvadala/node-ble/blob/main/docs/api.md#GattService) - [GattCharacteristic](https://github.com/chrvadala/node-ble/blob/main/docs/api.md#GattCharacteristic) +# Pre-requisites +This library works on many architectures supported by Linux. However Windows and Mac OS are currently *not* supported. + +It leverages the `bluez` driver, a component supported by the following platforms and distributions . + +*node-ble* has been tested on the following architectures: +- Raspbian +- Ubuntu + +```sh +sudo apt install bluetooth bluez libbluetooth-dev libudev-dev +``` + # Install ```sh npm install node-ble @@ -100,13 +113,6 @@ await device.disconnect() destroy() ``` -# Compatibility -This library works on many architectures supported by Linux. -It leverages on Bluez driver, a component supported by the following platforms and distributions https://www.bluez.org/about - -*Node-ble* has been tested on the following environment: -- Raspbian -- Ubuntu # Changelog - **0.x** - Beta version - **1.0** - First official version From 88209459fdb616828e7718ac108fddf27b32c5ac Mon Sep 17 00:00:00 2001 From: Ian Channing Date: Sun, 14 Apr 2024 16:35:13 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e366eff..c6befb2 100644 --- a/README.md +++ b/README.md @@ -22,16 +22,17 @@ Bluetooth Low Energy (BLE) library written with pure Node.js (no bindings) - bak - [GattCharacteristic](https://github.com/chrvadala/node-ble/blob/main/docs/api.md#GattCharacteristic) # Pre-requisites -This library works on many architectures supported by Linux. However Windows and Mac OS are currently *not* supported. +This library works on many architectures supported by Linux. However Windows and Mac OS are [*not* supported](https://github.com/chrvadala/node-ble/issues/31). It leverages the `bluez` driver, a component supported by the following platforms and distributions . *node-ble* has been tested on the following architectures: - Raspbian - Ubuntu +- Debian ```sh -sudo apt install bluetooth bluez libbluetooth-dev libudev-dev +sudo apt install dbus bluetooth bluez libbluetooth-dev libudev-dev ``` # Install From d6f294475acae0d19dc1dc501cb99b5ab67ff158 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Vadal=C3=A0?= Date: Sun, 19 May 2024 19:10:07 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index c6befb2..93a956b 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,6 @@ It leverages the `bluez` driver, a component supported by the following platform - Ubuntu - Debian -```sh -sudo apt install dbus bluetooth bluez libbluetooth-dev libudev-dev -``` - # Install ```sh npm install node-ble