Skip to content

Commit

Permalink
Add HA sensor value example to Readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
RoboMagus committed Jun 16, 2023
1 parent 5b0bbc3 commit 16571e8
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ text_sensor:
dirty: "-dirty"
```
Which for a clean config on the `dev` branch of a repo would yield in a sensor value as shown in the HomeAssistant example below:
![HA_sensor_example](./docs/ha_sensor_example.PNG)

### Configuration Options

Most options available to this sensor are flags for the [`git describe` command](https://git-scm.com/docs/git-describe).
Expand All @@ -52,4 +55,3 @@ This includes the following:

If there are uncommitted changes to any of these files, the provided `dirty` suffix will be added to the `git describe` output.


Binary file added docs/ha_sensor_example.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 16571e8

Please sign in to comment.