Skip to content

Commit

Permalink
Pre-requisites (#68)
Browse files Browse the repository at this point in the history
* 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à <[email protected]>
  • Loading branch information
ianchanning and chrvadala authored May 19, 2024
1 parent 2a4383e commit 9b17cf0
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.bluez.org/about>.

*node-ble* has been tested on the following architectures:
- Raspbian
- Ubuntu
- Debian

# Install
```sh
npm install node-ble
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 9b17cf0

Please sign in to comment.