From 53f257b89627bd2838b541ab28542fddcf736304 Mon Sep 17 00:00:00 2001 From: Adrian Edwards <17362949+MoralCode@users.noreply.github.com> Date: Thu, 21 Apr 2022 19:09:41 -0400 Subject: [PATCH] tweak readme to better convey that startErgScan is a stream of single instances --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index df666c8..342f241 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ ErgBleManager bleManager = ErgBleManager(); bleManager.init(); //ready to go! ``` ### Scanning for devices -Next, you need to start scanning for available devices. This uses a Stream that returns instances of the `Ergometer` class. Each of these instances represents an erg and can be saved for later reuse. +Next, you need to start scanning for available devices. This uses a Stream to return an instance of the `Ergometer` class for each erg found. Each of these instances represents an erg and can be saved for later reuse. **Important:** This library leaves things like permissions up to the application using the library. Many of these setup steps will fail if bluetooth is off or if permissions are not correct. It is the responsibility of users of this API to ensure permissions are correct before beginning a bluetooth scan.