aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 9717c3d34673be98e304600e566f338d00d2197e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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.