Skip to content

Commit

Permalink
Doc cleanup re install/upgrade
Browse files Browse the repository at this point in the history
  • Loading branch information
redstone99 committed Nov 19, 2024
1 parent 541686c commit ec55e29
Showing 1 changed file with 23 additions and 16 deletions.
39 changes: 23 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ This repository contains a Lovelace card to display and interact with [Alert2](h

## Install

### HACS install (recommended)
<details>
<summary>HACS install (recommended)</summary>

1. If HACS is not installed, follow HACS installation and configuration instructions at https://hacs.xyz/.

Expand All @@ -29,8 +30,10 @@ This repository contains a Lovelace card to display and interact with [Alert2](h


1. Click "Reload" when it prompts you to reload your browser.
</details>

### Manual install
<details>
<summary>Manual install</summary>

1. Download the `Source code (zip)` link from the repository [release section](https://github.com/redstone99/hass-alert2-ui/releases) under "Assets" and unzip it.

Expand All @@ -50,6 +53,24 @@ This repository contains a Lovelace card to display and interact with [Alert2](h
<config dir>/custom_components/alert2/sensor.py
... etc...

</details>

<details>
<summary>Upgrading</summary>

After upgrading Alert2 UI, it can take time for the browser or HA companion app to update alert2.js. To speed that up:

* On the web, try reloading the page a few times and also "Clear cookies & site data".

* On the Android HA companion app, try going to System Settings -> Apps -> Home Assistant -> Storage & cache and clicking "Clear cache". Then in the HA app, click on the vertical dots at the top and click on "Reload resources". You may need to wait a few seconds and click "Reload resources" twice.

</details
After installing or upgrading, you can verify the Alert2 UI version you're running by clicking on the "Alerts" header of the Lovelace card:
![Alert2 overview card with version info](resources/overview2.png)
## Setup
The install process above downloaded a js module, `alert2.js`.
Expand Down Expand Up @@ -103,8 +124,6 @@ Note - `alert2-overview` will show currently firing old Alert-1 alerts, but it w

![Alert2 overview card](resources/overview.png)

Clicking on the "Alerts" header will show the

### Detailed alert info

If you click on a specific alert listed in the alert overview, a dialog pops up with detailed info on the alert and notification controls. Example:
Expand All @@ -125,15 +144,3 @@ You may also add alert2 entities to entities cards and other cards that support

Finally, you can also view alert information by going to Settings -> Devices & Services -> Entities, typing "alert2." in the search box and browsing the list. Clicking on one will popup the "more-info dialog".

## Upgrading

After upgrading Alert2 UI, it can take time for the browser or HA companion app to update alert2.js. To speed that up:

* On the web, try reloading the page a few times and also "Clear cookies & site data".

* On the Android HA companion app, try going to System Settings -> Apps -> Home Assistant -> Storage & cache and clicking "Clear cache". Then in the HA app, click on the vertical dots at the top and click on "Reload resources". You may need to wait a few seconds and click "Reload resources" twice.

If you want to verify the Alert2 UI version you're running, you can click on the "Alerts" header of the Lovelace card to show the version:

![Alert2 overview card with version info](resources/overview2.png)

0 comments on commit ec55e29

Please sign in to comment.