From e1ab689de0b4bc3158b40b3ee9a488c16ee7d410 Mon Sep 17 00:00:00 2001 From: Maciej Gierada Date: Thu, 17 Aug 2023 10:23:06 +0200 Subject: [PATCH] fix: small fixes in readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b9708bb..9ab0961 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ All REST methods of the official public Govee API are supported. See the table b # Prerequisite -To use the library you need to obtain Govee Developer API key and set it to `GOVEE_API_KEY` env variable. It is highly suggested to use .env file. +To use the library you need to obtain a Govee Developer API key and set it to `GOVEE_API_KEY` env variable. It is highly suggested to use .env file. See below a short manual copied directly from the [Govee API documentation](https://app-h5.govee.com/share/community?client=0&postId=124855). Please refer to that documentation in case the info below is not sufficient or it changed over time. @@ -37,7 +37,7 @@ It is dead simple to use the `govee-api` library. ```rust // make sure to run this inside an async function -const GOVEE_API_KEY: &str = "GOVEE_API_KEY"; +const GOVEE_API_KEY: &str = "GOVEE_API_KEY"; // for the sake of security, please make sure this is read from env variable. let govee_client = GoveeClient::new(&GOVEE_API_KEY); // use any of the supported method from the table above // example for get_devices()