Skip to content

Commit

Permalink
doc: Add more recommended projects to README
Browse files Browse the repository at this point in the history
  • Loading branch information
qdot committed Dec 23, 2024
1 parent 2197dfc commit 73dbd12
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@ btleplug is an async Rust BLE library, supporting Windows 10, macOS, Linux, iOS,

It grew out of several earlier abandoned libraries for various platforms
([rumble](https://github.com/mwylde/rumble), [blurmac](https://github.com/servo/devices), etc...),
with the goal of building a fully cross platform library. Adding support for other platforms such as
Android is planned.
with the goal of building a fully cross platform library. If you're curious about how the library grew, [you can read more on that in this blog post](https://nonpolynomial.com/2023/10/30/how-to-beg-borrow-steal-your-way-to-a-cross-platform-bluetooth-le-library/).

btleplug is meant to be _host/central mode only_. If you are interested in peripheral BTLE (i.e.
acting like a Bluetooth LE device instead of connecting to one), check out
[bluster](https://github.com/dfrankland/bluster/tree/master/src).
[bluster](https://github.com/dfrankland/bluster/) or [ble-peripheral-rust](https://github.com/rohitsangwan01/ble-peripheral-rust/).

This library **DOES NOT SUPPORT BLUETOOTH 2/CLASSIC**. There are no plans to add BT2/Classic
support.
Expand Down Expand Up @@ -75,7 +74,7 @@ To enable implementation of serde's `Serialize` and `Deserialize` across some co

```toml
[dependencies]
btleplug = { version = "0.10", features = ["serde"] }
btleplug = { version = "0.11", features = ["serde"] }
```

## Build/Installation Notes for Specific Platforms
Expand Down Expand Up @@ -160,8 +159,16 @@ There are also some examples in the Flutter shim listed below.

### Flutter

While we don't specifically support Flutter in this repo yet, there's a template repo available at
[https://github.com/trobanga/flutter_btleplug](https://github.com/trobanga/flutter_btleplug). This template has builds for both Android and iOS using btleplug.
While we don't specifically support Flutter, there's a template repo available at
[https://github.com/trobanga/flutter_btleplug](https://github.com/trobanga/flutter_btleplug). This
template has builds for both Android and iOS using btleplug.

As flutter compilation tends to be complex across platforms, we cannot help with flutter build issues.

### Tauri

While we don't specifically support Tauri, there's a plugin available at
[https://github.com/MnlPhlp/tauri-plugin-blec](https://github.com/MnlPhlp/tauri-plugin-blec). Please note that all Tauri questions should go to the plugin repo before coming here, we cannot help with Tauri issues as none of this project's developers use Tauri.

## Alternative Libraries

Expand Down

0 comments on commit 73dbd12

Please sign in to comment.