diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9717c3d --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Porch + +Step onto the `porch` and see the weather! + +## 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`. + +To get weather for your default city (if set), run: + +```sh +porch +``` + +To get weather for any city, run: + +```sh +porch <city> +``` + +For example: + +```sh +porch New York +``` + +`porch` can handle spaces in city names. |