Skip to content

Commit

Permalink
πŸ“ (core): Update README.md for release (#103)
Browse files Browse the repository at this point in the history
  • Loading branch information
mbertin-ledger authored Jun 14, 2024
2 parents 8248381 + 822bdd4 commit dee4118
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Device SDK Core Library Documentation

> [!CAUTION]
> This is still under development and we are free to make new interfaces which may lead to Device SDK breaking changes.

- [Device SDK Core Library Documentation](#device-sdk-core-library-documentation)
- [Description](#description)
- [Installation](#installation)
Expand Down Expand Up @@ -52,6 +56,9 @@ Some of the APIs exposed return objects of type `Observable` from RxJS. Ensure y
- Close app
- Get battery status

> [!NOTE]
> At the moment we do not provide the possibility to distinguish two devices of the same model, via USB and to avoid connection to the same device twice.
### Setting up the SDK

The core package exposes an SDK builder `DeviceSdkBuilder` which will be used to initialise the SDK with your configuration.
Expand Down

0 comments on commit dee4118

Please sign in to comment.