Skip to content

Commit

Permalink
update desc
Browse files Browse the repository at this point in the history
  • Loading branch information
ludeeus committed Jul 16, 2019
1 parent 34c2410 commit 9acd01b
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Expand Up @@ -2,8 +2,8 @@

A platform which allows you to get information from alerts.weather.gov.

To get started put `/custom_components/weatheralerts/sensor.py` here:
`<config directory>/custom_components/weatheralerts/sensor.py`
To get started put all the files from `/custom_components/weatheralerts/` here:
`<config directory>/custom_components/weatheralerts/`

**Example configuration.yaml:**

Expand All @@ -26,5 +26,3 @@ key | description

To find the sameid go to [http://www.nws.noaa.gov/nwr/coverage/county_coverage.html](http://www.nws.noaa.gov/nwr/coverage/county_coverage.html).

***
Due to how `custom_components` are loaded, it is normal to see a `ModuleNotFoundError` error on first boot after adding this, to resolve it, restart Home-Assistant.
21 changes: 21 additions & 0 deletions info.md
@@ -0,0 +1,21 @@
**Example configuration.yaml:**

```yaml
sensor:
platform: weatheralerts
sameid: '034035'
```

**Configuration variables:**

key | description
:--- | :---
**platform (Required)** | The platform name.
**sameid (Required)** | The SAME ID for your county.

## Sample overview

![Sample overview](overview.png)

To find the sameid go to [http://www.nws.noaa.gov/nwr/coverage/county_coverage.html](http://www.nws.noaa.gov/nwr/coverage/county_coverage.html).

0 comments on commit 9acd01b

Please sign in to comment.