Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Extensive testing on Bluetooth hardware (Nordic nRF52840 Dongle)
- API stabilization for 1.0.0 release

## [0.1.1-alpha] - 2024-12-27

### Added
- **Refactor:** Retroactive @unchecked Sendable conformances replaced with transport-level wrapper
- Added RSSI Reading Support with Async/Await API
- Added System-Connected Peripherals Retrieval

## [0.1.0-alpha] - 2024-10-22

### Added
Expand Down
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing

Thanks for your interest in ActorCoreBluetooth!

This project is actively evolving, and contributions, ideas, and feedback are very welcome.

## How to get involved

If you have an idea for a feature, API improvement, or behavior change:
- please consider starting a GitHub Discussion to describe the idea and motivation
- early discussion helps align on design and concurrency constraints

Small improvements, experiments, and fixes are welcome as pull requests without prior discussion.

## Pull Requests

- Keep PRs focused on a single logical change
- Follow existing code style and concurrency patterns
- Prefer clarity and correctness over cleverness
- If a change affects public API or concurrency guarantees, please mention it explicitly

## Design principles

ActorCoreBluetooth is built around:
- actor isolation
- async/await–based APIs
- explicit concurrency boundaries

Please keep these principles in mind when proposing changes.

Thanks for helping improve the project!

16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](LICENSE)
[![CI](https://github.com/Linqa2/ActorCoreBluetooth/actions/workflows/ci.yml/badge.svg)](https://github.com/Linqa2/ActorCoreBluetooth/actions)

**⚠️ v0.1.0-alpha - APIs may change**
**⚠️ v0.1.1-alpha - APIs may change**

A modern Swift Bluetooth library providing async/await APIs for CoreBluetooth using MainActor isolation. Built for Swift 6 with strict concurrency compliance and comprehensive logging.

Expand Down Expand Up @@ -433,14 +433,14 @@ Add this to your `Package.swift` file:

```swift
dependencies: [
.package(url: "https://github.com/Linqa2/ActorCoreBluetooth.git", exact: "v0.1.0-alpha")
.package(url: "https://github.com/Linqa2/ActorCoreBluetooth.git", exact: "v0.1.1-alpha")
]
```

Or add it through Xcode:
1. File → Add Package Dependencies
2. Enter: `https://github.com/Linqa2/ActorCoreBluetooth.git`
3. Select version: `v0.1.0-alpha`
3. Select version: `v0.1.1-alpha`

## Requirements

Expand All @@ -456,6 +456,16 @@ Or add it through Xcode:

[Modernizing CoreBluetooth with Swift 6 Concurrency: The ActorCoreBluetooth Story](https://medium.com/@konst.polin/modernizing-corebluetooth-with-swift-6-concurrency-the-actorcorebluetooth-story-c5ff95b7d68a)

## Contributing

ActorCoreBluetooth is actively evolving, and contributions are welcome.

If you have an idea for a feature, API improvement, or design change,
please start a GitHub Discussion.

Small PRs and experiments are always welcome as well.
See `CONTRIBUTING.md` for more details.


## License

Expand Down