From 9b17cf0e4ea4f5ad15c6b6fbebb8fabd718554d7 Mon Sep 17 00:00:00 2001 From: Ian Channing Date: Sun, 19 May 2024 19:12:03 +0200 Subject: [PATCH] Pre-requisites (#68) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Pre-requisites section - Move the compatibility section to the top. - Explicitly mention that Windows and Mac OS are not supported - Mention `apt` install * Update README.md * Update README.md --------- Co-authored-by: Christian Vadalà --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4da4f6d..8c7a034 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,16 @@ 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 [*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 + # Install ```sh npm install node-ble @@ -100,13 +110,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