Skip to content

Commit

Permalink
fix: small fixes in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mgierada committed Aug 17, 2023
1 parent 278fbcc commit e1ab689
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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()
Expand Down

0 comments on commit e1ab689

Please sign in to comment.