docs: Add usage

Signed-off-by: Tim Hårek Andreassen <tim@harek.no>
This commit is contained in:
Tim Hårek Andreassen 2024-10-03 16:13:14 +02:00
parent 10e1c770af
commit 5fb146f602
No known key found for this signature in database
GPG key ID: E59C7734F0E10EB5

View file

@ -1,5 +1,28 @@
# yr-go
# yr
This is currently work in progress. My goal with this is to learn more Go and
have a Go-package that I can use from met.no and hopefully a CLI tool to check
the weather.
Get the weather delivered to your command-line.
## 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
```