diff --git a/README.md b/README.md index 55cda64..44212b4 100644 --- a/README.md +++ b/README.md @@ -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). @@ -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. - diff --git a/docs/ha_sensor_example.PNG b/docs/ha_sensor_example.PNG new file mode 100644 index 0000000..f597258 Binary files /dev/null and b/docs/ha_sensor_example.PNG differ