yr/README.md

[![builds.sr.ht status](https://builds.sr.ht/~timharek/yr/commits/main/.build.yml.svg)](https://builds.sr.ht/~timharek/yr/commits/main/.build.yml?)

# [yr]

![screenshot](./screenshot.png)

Get the weather delivered to your command-line, or use as a Go package.

The project uses [Meteorologisk institutt]'s public API, [`LocationForecast`],
and [OpenStreetMap]'s [Nominatim] API.

## Install CLI

Using go:

```bash
go install git.sr.ht/~timharek/yr@latest
```

Adding more methods in the future. Help is wanted to achieve the best coverage.

### Using pre-compiled binary

Select the version you want to install [available releases] and download
it and add it to your `bin` or something similar.

Example:

```bash
wget https://git.sr.ht/~timharek/yr/refs/download/<release>/yr-<version>-linux-amd64.tar.gz
tar xf yr-<version>-linux-amd64.tar.gz
cd yr-<version>
cp yr /usr/local/bin
```

## Usage

```bash
# Get help
yr --help

# Current forecast for location
yr now bergen

# Or with a space
yr now "new york"

# Forecast for multiple hours
yr forecast "new york"

# Forecast for next 5 hours
yr forecast "new york" -i 5

# Open forecast in your web browser
yr forecast "new york" --web

# Open now in your web browser
yr now "new york" --web
```

### As a package

```go
import "git.sr.ht/~timharek/yr/yr"

func weather() {
  y := yr.New()

  now := y.Now("bergen")

  // Use the data
}
```

## Contributing

Anyone can contribute to [yr]. Please refer to the [contribution guidelines].

Send patches to the [mailing list], report bugs on the [issue tracker].

[yr]: https://sr.ht/~timharek/yr/
[Meteorologisk institutt]: https://www.met.no/
[`LocationForecast`]: https://api.met.no/weatherapi/locationforecast/2.0/documentation
[OpenStreetMap]: https://www.openstreetmap.org/
[Nominatim]: https://nominatim.org/
[mailing list]: https://lists.sr.ht/~timharek/yr
[issue tracker]: https://todo.sr.ht/~timharek/yr
[contribution guidelines]: ./CONTRIBUTING.md
[available releases]: https://git.sr.ht/~timharek/yr/refs