Skip to content

Commit c9db767

Browse files
committed
Document depending on BLEPluginSDK from the root package
1 parent f640b92 commit c9db767

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

PluginSDK/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,22 @@ data, a characteristic or a descriptor value — into labelled fields the app di
88
- `Examples/BatteryLevel/` — a complete plugin (GATT Battery Level, `0x2A19`) you can copy.
99
- `../Documentation/PluginABI.md` — the normative wire contract.
1010

11+
## Depending on the SDK
12+
13+
`BLEPluginSDK` is a product of the root `bluetooth-explorer` package, so an external plugin author
14+
can consume it by adding this repository as a dependency and importing `BLEPluginSDK`:
15+
16+
```swift
17+
.package(url: "https://github.com/MillerTechnologyPeru/BluetoothExplorer.git", branch: "master"),
18+
// ... .product(name: "BLEPluginSDK", package: "bluetooth-explorer")
19+
```
20+
21+
> **Note:** consuming the root package this way currently fails to resolve, because the app's
22+
> `AndroidSwiftUI` dependency uses a local sub-package that SwiftPM forbids in a branch-pinned
23+
> dependency graph. Until that is fixed upstream, build against the standalone
24+
> `PluginSDK/BLEPluginSDK` package instead — which is exactly what the in-repo examples do
25+
> (`.package(path: "../../BLEPluginSDK")`). Both manifests build the same sources.
26+
1127
## Prerequisites
1228

1329
```sh

0 commit comments

Comments
 (0)