Skip to content
This repository has been archived by the owner on Aug 27, 2022. It is now read-only.

Commit

Permalink
Reviewed version and changelog.
Browse files Browse the repository at this point in the history
  • Loading branch information
kdewald committed Dec 15, 2021
1 parent 5c11422 commit c5cc248
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 10 deletions.
6 changes: 2 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.0.2] - 2021-XX-XX

### Changed
- SimpleDBus Connection object is now passed around as a shared pointer.
## [0.1.0] - 2021-12-14
- Reimplementation of the library based on the SimpleDBus v2.0.0-alpha.2 API.

## [0.0.1] - 2021-11-09
- First working implementation post migration, following the SimpleDBus v2.0.0-alpha API.
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,15 +73,10 @@ specifying the additional command line arguments to the `cmake` command:
default location of the LibFmt repository.

## More information
- You can find the official documentation for BlueZ in [this link](https://git.kernel.org/pub/scm/bluetooth/bluez.git/plain/doc/gatt-api.txt).

## Known issues
- The handling of all externally exposed components with `std::shared_ptr` is not particularly safe in case the underlying object gets deleted by BlueZ, as the end user still has the capability to send requests to that deleted object. This will be addressed in a future release, but it's important for users of SimpleDBus to keep in mind.
- You can find the official documentation for Bluez in [this link](https://git.kernel.org/pub/scm/bluetooth/bluez.git/plain/doc/gatt-api.txt).

## Contributing
If you want to help, here is what's needed:
- The remaining functionality of the existing components.
- Errors are currently not being caught and surfaced up.
- More documentation.
- More examples.
- Logging

0 comments on commit c5cc248

Please sign in to comment.