diff options
| -rw-r--r-- | README.md | 9 |
1 files changed, 7 insertions, 2 deletions
@@ -2,11 +2,16 @@ Step onto the `porch` and see the weather! +## Building + +Use either `go build` or `make` in the project root. +The default `make` target strips debug info, producing a slightly smaller binary -- 7.1 MB vs 10.2 MB on my `musl` system. + ## Usage First, place your OpenWeatherMap API key in `~/.config/porch/key.txt`. -You can get one for free [here](https://openweathermap.org/). -If you wish, you can place your home city in `~/.config/porch/defaultCity.txt`. +OpenWeatherMap offers a free API plan with very generous limits; you can get started [here](https://openweathermap.org/). +If you wish, you can also place your home city in `~/.config/porch/defaultCity.txt`. To get weather for your default city (if set), run: |