Skip to content

Commit

Permalink
adds compatibility paragraph
Browse files Browse the repository at this point in the history
  • Loading branch information
chrvadala committed Jun 20, 2020
1 parent 0612fac commit 99bbf70
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,23 @@ const {bluetooth, destroy} = createBluetooth()
| --- | --- |
| valuechanged | New value is notified. (invoke `startNotifications()` to enable notifications)

## 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 GNU/Linux 10 (buster)
- Ubuntu 18.04.4 LTS

## Changelog
- **0.x** - Beta version
- **1.0** - First official version
- **1.1** - Migrates to gh-workflows
- **1.2** - Upgrades deps

## Contributors
- [chrvadala](https://github.com/chrvadala) (author)

## Run tests
In order to run test suite you have to set up right DBus permissions.

Expand Down Expand Up @@ -224,15 +241,6 @@ TEST_NOTIFY_CHARACTERISTIC=00002a37-0000-1000-8000-00805f9b34fb
yarn test:e2e
```

## Changelog
- **0.x** - Beta version
- **1.0** - First official version
- **1.1** - Migrates to gh-workflows
- **1.2** - Upgrades deps

## Contributors
- [chrvadala](https://github.com/chrvadala) (author)

## References
- https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/doc/adapter-api.txt
- https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/doc/device-api.txt
Expand Down

0 comments on commit 99bbf70

Please sign in to comment.