diff --git a/README.md b/README.md index df14aea0..5415eac2 100644 --- a/README.md +++ b/README.md @@ -115,15 +115,15 @@ See this Arduino-Pico SDK [documentation](https://arduino-pico.readthedocs.io/en For new `Firebase` users, please read the [Project Preparation and Setup](#project-preparation-and-setup) section for preparing the Firebase project. -For new library user that the project was setup and prepared, see the [bare minimun examples](/examples/BareMinimum/) to start using this library with minimum code that requires by this library. +For new library user that the project was setup and prepared, see the [bare minimun examples](/examples/BareMinimum/) to start using this library with minimum code that is required by this library. For more examples, please click [here](/examples/). ### Working Principle -This library can be used in two modes i.e. async mode and await or sinc mode. +This library can be used in two modes i.e. async mode and await or sync mode. -With async mode, the task will store in the FIFO queue. The result of the running task can be obtained via the callback function or the proxy object that assign when calling the functions. +With async mode, the task will be stored in the FIFO queue. The result of the running task can be obtained via the callback function or the proxy object that is assigned when calling the functions. The `AsyncClientClass` is the proxy class that provides the queue for async tasks and also the information of task process when working in await or sync mode. @@ -712,4 +712,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of `THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.` -*Last updated 2025-05-29 UTC.* \ No newline at end of file +*Last updated 2025-05-29 UTC.* diff --git a/examples/BareMinimum/RealtimeDatabase/RealtimeDatabase.ino b/examples/BareMinimum/RealtimeDatabase/RealtimeDatabase.ino index 5d1fa2f9..42cd2089 100644 --- a/examples/BareMinimum/RealtimeDatabase/RealtimeDatabase.ino +++ b/examples/BareMinimum/RealtimeDatabase/RealtimeDatabase.ino @@ -119,11 +119,11 @@ UserAuth user_auth("Web_API_KEY", "USER_EMAIL", "USER_PASSWORD"); FirebaseApp app; // Step 5 -// Use two SSL clients for sync and async tasks for demonstation only. +// Use two SSL clients for sync and async tasks for demonstration only. WiFiClientSecure ssl_client1, ssl_client2; // Step 6 -// Use two AsyncClients for sync and async tasks for demonstation only. +// Use two AsyncClients for sync and async tasks for demonstration only. using AsyncClient = AsyncClientClass; AsyncClient async_client1(ssl_client1), async_client2(ssl_client2);