diff --git a/README.md b/README.md index ba72398..56c53f5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,12 @@ -# NWS Alerts (nws_alerts) +# Alerts from the US National Weather Service (nws_alerts) 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. + +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. + +The sensor that is created is used in my "NWS Alerts Custom" package - https://github.com/finity69x2/NWS-Alerts-Custom-Package ## Installation: