Skip to content

Commit 75c790c

Browse files
author
Marco Crespi
committed
Merge branch 'develop'
2 parents c0276ed + 10be7fb commit 75c790c

File tree

207 files changed

+5208
-4400
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

207 files changed

+5208
-4400
lines changed

.husky/.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
_
1+
_

.husky/pre-commit

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
#!/bin/sh
22
. "$(dirname "$0")/_/husky.sh"
33

4-
npx precise-commits
4+
npm run pretty-quick

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,21 +49,33 @@ Trying to make the world better place by improving the bluetooth experience one
4949

5050
### Installation
5151

52+
Install the module from npm:
53+
5254
```bash
5355
npm i -E @modum-io/modblue
5456
```
5557

56-
### Usage
57-
58-
Currently there are the following bindings available:
58+
Then install the peer depencies depending on which one(s) you want to use:
5959

6060
- `hci` (using [bluetooth-hci-socket](https://github.com/abandonware/node-bluetooth-hci-socket))
61+
62+
```bash
63+
npm i -E @abandonware/bluetooth-hci-socket
64+
```
65+
6166
- `dbus` (using [dbus-next](https://github.com/dbusjs/node-dbus-next))
6267

68+
```bash
69+
npm i -E dbus-next
70+
```
71+
72+
### Usage
73+
6374
Create a new `MODblue` object to get started (all bindings have the same interface)
6475

6576
```ts
66-
import { HciMODblue, DbusMODblue } from '@modum-io/modblue';
77+
import { HciMODblue } from '@modum-io/modblue/hci'; // for hci bindings
78+
// import { DbusMODblue } from '@modum-io/modblue/dbus'; // for dbus bindings
6779

6880
const modblue = new HciMODblue(); // or: new DbusMODblue()
6981
```

docs/assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/adapter.html

Lines changed: 38 additions & 44 deletions
Large diffs are not rendered by default.

docs/classes/dbusmodblue.html

Lines changed: 0 additions & 319 deletions
This file was deleted.

0 commit comments

Comments
 (0)