Skip to content

Commit d3416b0

Browse files
committed
Updated README
1 parent b0fd846 commit d3416b0

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,11 @@ Does not require [BlueZ](https://www.bluez.org), communicates directly with the
1919
import Bluetooth
2020
import BluetoothLinux
2121

22-
guard let hostController = HostController.default
23-
else { Error("No Bluetooth adapters found") }
24-
let iBeaconUUID = Foundation.UUID(rawValue: "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0")!
25-
do { try hostController.enableBeacon(uuid: iBeaconUUID, major: 1, minor: 1, rssi: -29) }
22+
guard let hostController = BluetoothLinux.HostController.default
23+
else { fatalError("No Bluetooth adapters found") }
24+
let uuid = UUID(rawValue: "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0")!
25+
let beacon = AppleBeacon(uuid: uuid, major: 1, minor: 1, rssi: -29)
26+
do { try hostController.iBeacon(beacon) }
2627
catch { print("Error enabling iBeacon: \(error)") }
2728
```
2829

@@ -35,7 +36,10 @@ import PackageDescription
3536

3637
let package = Package(
3738
dependencies: [
38-
.Package(url: "https://github.com/PureSwift/BluetoothLinux.git", majorVersion: 3)
39+
.package(
40+
url: "https://github.com/PureSwift/BluetoothLinux.git",
41+
.branch("master")
42+
)
3943
]
4044
)
4145
```
@@ -55,14 +59,12 @@ Read the documentation [here](http://pureswift.github.io/BluetoothLinux/docs/).
5559

5660
Do not test in Parallels or VMware with the built in Bluetooth adapter found in Macs. You can, however, use VMWare or Parallels, with a Linux compatible Bluetooth LE USB adapter plugged in. VirtualBox will work with the builtin adapter on Macs.
5761

58-
For best results, test with Swift 4.1.2 on an ARM board running Linux (e.g. BeagleBoneBlack, Raspberry Pi, Orange Pi, etc) and a Linux comaptible Bluetooth dongle (e.g. CSR8510 A10).
62+
For best results, test with [Swift 5.1.5 on ARMv7](https://github.com/uraimo/buildSwiftOnARM) and a Linux-comptible Bluetooth dongle (e.g. CSR8510 A10).
5963

6064
## See Also
6165

6266
- [Bluetooth](https://github.com/PureSwift/Bluetooth) - Pure Swift Bluetooth Definitions.
6367
- [GATT](https://github.com/PureSwift/GATT) - Bluetooth Generic Attribute Profile (GATT) for Swift
64-
- [SwiftFoundation](https://github.com/PureSwift/SwiftFoundation) - Cross-Platform, Protocol-Oriented Programming base library to complement the Swift Standard Library.
65-
- [Cacao](https://github.com/PureSwift/Cacao) - Pure Swift Cross-platform UIKit
6668
- [Silica](https://github.com/PureSwift/Silica) - Pure Swift CoreGraphics (Quartz2D) implementation
6769
- [Predicate](https://github.com/PureSwift/Predicate) - Pure Swift Predicate implementation
6870

@@ -71,7 +73,7 @@ License
7173

7274
**BluetoothLinux** is released under the MIT license. See LICENSE for details.
7375

74-
[swift-badge]: https://img.shields.io/badge/Swift-4.1-orange.svg?style=flat
76+
[swift-badge]: https://img.shields.io/badge/Swift-5.1-orange.svg?style=flat
7577
[swift-url]: https://swift.org
7678
[platform-badge]: https://img.shields.io/badge/platform-linux-lightgrey.svg
7779
[platform-url]: https://swift.org

0 commit comments

Comments
 (0)