From 6c7fa74e6564260448c36115a99c7f01abc76b56 Mon Sep 17 00:00:00 2001 From: twells46 Date: Sat, 7 Mar 2026 09:17:59 -0600 Subject: Update README --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9717c3d..950014e 100644 --- a/README.md +++ b/README.md @@ -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: -- cgit v1.2.3