docs: Add CLI install instructions

Signed-off-by: Tim Hårek Andreassen <tim@harek.no>
This commit is contained in:
Tim Hårek Andreassen 2024-10-03 19:44:42 +02:00
parent 7d256f0ca6
commit 112ba8795d
No known key found for this signature in database
GPG key ID: E59C7734F0E10EB5

View file

@ -1,3 +1,5 @@
[![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]
Get the weather delivered to your command-line, or use as a Go package.
@ -5,6 +7,12 @@ 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: `go install git.sr.ht/~timharek/yr`
Adding more methods in the future. Help is wanted to achieve the best coverage.
## Usage
```bash