Skip to content

Commit

Permalink
Improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcoGos committed Sep 15, 2023
1 parent 489a4c4 commit bfc7f70
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,30 @@
![Version](https://img.shields.io/github/v/release/MarcoGos/gfsforecast?include_prereleases)
![Version](https://img.shields.io/github/v/release/MarcoGos/gfs_weather_forecast?include_prereleases)

# GFS Forecast

This is a custom integration of the GFS Forecast. It will provide a weather entity based on the information gathered with the GFS Forecast addon.
This is a custom integration of the GFS Weather Forecast. It will provide a weather entity based on the information gathered with the GFS Weather Forecast addon.

## Installation

First make sure you installed the GFS Weather Forecast addon, see https://github.com/MarcoGos/ha-addons. After the addon is running you can install this integration.

Via HACS:

- Add the following custom repository as an integration:
- MarcoGos/gfsforecast
- MarcoGos/gfs_weather_forecast
- Restart Home Assistant
- Add the integration to Home Assistant

## Setup

During the setup of the integration a region, name, latitude and longitude needs to be provided.
During the setup of the integration the api port of the addon needs to be provided, the default port is 8000.

![Setup](/assets/setup.png)

## What to expect

The following sensors will be registered:

![Sensors](/assets/sensors.png)

The sensor information is updated every 4 hours.

![Sensors](/assets/sensors.png)
Binary file added assets/sensors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/setup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed custom_components/.DS_Store
Binary file not shown.

0 comments on commit bfc7f70

Please sign in to comment.