Skip to content

Commit

Permalink
README: add note on API stability
Browse files Browse the repository at this point in the history
  • Loading branch information
aykevl committed May 31, 2020
1 parent 47097f9 commit d9d4255
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,17 @@ Flashing will then need to be done a bit differently, using the CMSIS-DAP interf

tinygo flash -target=microbit-s110v8 -programmer=cmsis-dap ./examples/heartrate

## API stability

**The API is not stable!** Because many features are not yet implemented and some platforms (e.g. MacOS) are not yet supported, it's hard to say what a good API will be. Therefore, if you want stability you should pick a particular git commit and use that. Go modules can be useful for this purpose.

Some things that will probably change:

* Add options to the `Scan` method, for example to filter on UUID.
* Change advertisement configuration to accept structured BLE packets instead of raw packets.
* Connect/disconnect events.
* The behavior around advertisement. Nordic SoftDevices stop advertising when a device connects, which is somewhat unintuitive.

## License

This project is licensed under the BSD 3-clause license, see the LICENSE file for details.
Expand Down

0 comments on commit d9d4255

Please sign in to comment.