Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
andrew-codechimp committed Sep 7, 2023
1 parent b2c4172 commit 5bab129
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

_Integration to add battery notes to a device._

![Battery Notes](https://github.com/andrew-codechimp/HA-Battery-Notes/blob/main/images/screenshot-device.png "Battery Notes")

**This integration will set up the following platforms.**

Platform | Description
Expand All @@ -24,7 +26,7 @@ Platform | Description
1. Add the project repository `https://github.com/andrew-codechimp/HA-Battery-Notes` as a custom repository to HACS, see: https://hacs.xyz/docs/faq/custom_repositories
1. Search for `Battery Notes` in HACS and install it under the "Integrations" category.
1. Restart Home Assistant
1. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Mastodon Profile Stats"
1. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Battery Notes"

### Manual Installation

Expand All @@ -41,6 +43,9 @@ Platform | Description

## Configuration is done in the UI

On the "Configuration" -> "Integrations" -> "Battery Notes" screen add a new device, pick your device with a battery and add the battery type.
The battery type will then be displayed as a diagnotic sensor on the device.

<!---->

## Contributions are welcome!
Expand Down
Binary file added images/screenshot-device.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 5bab129

Please sign in to comment.