From aa1a15e835fd83b4b0e0dc5f8d6359a5beda9df5 Mon Sep 17 00:00:00 2001 From: finity69x2 <32221243+finity69x2@users.noreply.github.com> Date: Fri, 21 Apr 2023 23:34:32 -0400 Subject: [PATCH] Update README.md --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e62890d..32888c0 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ An updated version of the nws_alerts custom integration for Home Assistant originally found at github.com/eracknaphobia/nws_custom_component -This integration retrieves updated weather alerts every minute from the US NWS API. +This integration retrieves updated weather alerts every minute from the US NWS API (by default but it can be changed in the config options). The integration presents the number of currently active alerts as the state of the sensor and lists many alert details as a list in the attributes of the sensor. @@ -24,7 +24,7 @@ Clone the Repository and copy the "nws_alerts" directory to your "custom_compone open the HACS section of Home Assistant. -Click the "+ Explore & Add New repositories" button in the bottom right corner. +Click the "+ Explore & Download Repositories" button in the bottom right corner. In the window that opens search for "NWS Alerts". @@ -34,12 +34,12 @@ After installing the integration you can then configure it using the instruction ## Configuration: -You can find your Zone or County ID by going to https://alerts.weather.gov/, scroll down to your state and click on the “zone list” and/or "county list" then look for the entry for your county. - There are two ways to configure this integration. Manually via an entry in your configuration.yaml file: +You can find your Zone or County ID by going to https://alerts.weather.gov/, scroll down to your state and click on the “zone list” and/or "county list" then look for the entry for your county. + To create a sensor instance add the following configuration to your sensor definitions using the zone_id found above: ``` @@ -68,5 +68,6 @@ Using the configuration example above the sensor will then be called "sensor.my_ Or you can configure the integration via the "Configuration->Integrations" section of the Home Assistant UI. -Look for the integration labeled "NWS Alerts" +Click on "+ Add Integration" buuton in the bottom right corner. +Search for "NWS Alerts" in the list of integrations and follow the UI prompts to configure the sensor.