Skip to content

Commit

Permalink
add clarity to readme for configuration. closes #33
Browse files Browse the repository at this point in the history
  • Loading branch information
snicker committed Aug 14, 2024
1 parent 53c1b9f commit 054e069
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Installation
===

1. Install this from HACs
2. Add a configuration similar to the one below to your HA configuration. Players should be a list of "player_id" numbers that you wish to track. Your own `player_id` will be automatically included unless you specify the `include_self` directive in your sensor config and set it to `false`
2. Add a configuration similar to the one below to your HA configuration.

```
sensor:
Expand All @@ -24,6 +24,12 @@ sensor:

3. Restart HomeAssistant

### Configuration Tips and Tricks

* Use your Zwift email address for `my_zwift_username` above.
* `players:` should be a list of "player_id" numbers that you wish to track.
* Your own `player_id` will be automatically included unless you specify the `include_self` directive in your sensor config and set it to `false`

Events
===

Expand Down

0 comments on commit 054e069

Please sign in to comment.