Eric Rakestraw
fba519cab0
All checks were successful
ci/woodpecker/push/build-image Pipeline was successful
41 lines
1.5 KiB
Markdown
41 lines
1.5 KiB
Markdown
# weatherfeeder
|
|
|
|
`weatherfeeder` is a config-driven daemon that polls weather providers, normalizes
|
|
provider-specific responses into canonical weather events, and routes those
|
|
events to configured sinks.
|
|
|
|
It currently supports NWS observations, alerts, hourly forecasts, narrative
|
|
forecasts, forecast discussions, and weather stories; SPC Day 1-3 convective
|
|
outlooks; Open-Meteo observations and hourly forecasts; and OpenWeather
|
|
observations. Implemented sinks are stdout, NATS, and Postgres.
|
|
|
|
## Quickstart
|
|
|
|
Run the checked-in sample config:
|
|
|
|
```sh
|
|
cd cmd/weatherfeeder
|
|
go run .
|
|
```
|
|
|
|
The sample config at `cmd/weatherfeeder/config.yml` is load-tested and can be
|
|
used as a starting point. The executable always reads `config.yml` from its
|
|
current working directory.
|
|
|
|
## Documentation
|
|
|
|
- [CLI reference](docs/cli.md)
|
|
- [Configuration reference](docs/config.md)
|
|
- [Operations guide](docs/operations.md)
|
|
- [Troubleshooting guide](docs/troubleshooting.md)
|
|
- [Example configs](examples/)
|
|
- [Event wire contract](docs/integrations/events.md)
|
|
- [Postgres table contract](docs/integrations/postgres.md)
|
|
- [NWS integration notes](docs/integrations/nws.md)
|
|
- [SPC integration notes](docs/integrations/spc.md)
|
|
- [Open-Meteo integration notes](docs/integrations/openmeteo.md)
|
|
- [OpenWeather integration notes](docs/integrations/openweather.md)
|
|
- [Architecture policy](docs/policy/architecture.md)
|
|
- [Development policy](docs/policy/development.md)
|
|
- [Documentation policy](docs/policy/documentation.md)
|