~kota/metweather

83116598931ede516d42fdc141a16977bd547642 — Dakota Walsh 4 months ago c166ea9
add readme
1 files changed, 31 insertions(+), 0 deletions(-)

A README.md
A README.md => README.md +31 -0
@@ 0,0 1,31 @@
# metweather [![builds.sr.ht status](https://builds.sr.ht/~kota/metweather.svg)](https://builds.sr.ht/~kota/metweather)

Display weather information from [Metservice](https://www.metservice.com/).

# Usage

```
metweather [command] [flags]

GLOBAL flags
      --config string     config file (default is $XDG_CONFIG_HOME/.metweather.yaml)
  -h, --help              help for metweather
  -v, --version           version for metweather
  -l, --location string   location used for the weather observation/forecast

observation: display current or past weather observations
forecast: display weather predictions for the current day or next serveral days
```

# Config Example

```yaml
location: Dunedin
```

alternatively you can set an environment variable
`METWEATHER_LOCATION="Dunedin"`

# Resources

Discussion and patches can be found [here](https://lists.sr.ht/~kota/public-inbox).