Skip to content

Commit 9b17cf0

Browse files
Pre-requisites (#68)
* 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à <chr.vadala@gmail.com>
1 parent 2a4383e commit 9b17cf0

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,16 @@ Bluetooth Low Energy (BLE) library written with pure Node.js (no bindings) - bak
2121
- [GattService](https://github.com/chrvadala/node-ble/blob/main/docs/api.md#GattService)
2222
- [GattCharacteristic](https://github.com/chrvadala/node-ble/blob/main/docs/api.md#GattCharacteristic)
2323

24+
# Pre-requisites
25+
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).
26+
27+
It leverages the `bluez` driver, a component supported by the following platforms and distributions <https://www.bluez.org/about>.
28+
29+
*node-ble* has been tested on the following architectures:
30+
- Raspbian
31+
- Ubuntu
32+
- Debian
33+
2434
# Install
2535
```sh
2636
npm install node-ble
@@ -100,13 +110,6 @@ await device.disconnect()
100110
destroy()
101111
```
102112

103-
# Compatibility
104-
This library works on many architectures supported by Linux.
105-
It leverages on Bluez driver, a component supported by the following platforms and distributions https://www.bluez.org/about
106-
107-
*Node-ble* has been tested on the following environment:
108-
- Raspbian
109-
- Ubuntu
110113
# Changelog
111114
- **0.x** - Beta version
112115
- **1.0** - First official version

0 commit comments

Comments
 (0)