aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSam Chudnick <sam@chudnick.com>2023-06-10 09:24:50 -0400
committerSam Chudnick <sam@chudnick.com>2023-06-10 09:24:50 -0400
commitd86f42d8ab1c2a34a3d0e8bd23f57aef6d8d670b (patch)
treee578209d0d51e372ba2bf8925dcaedc2b62c97a5
parente1144d41f1924ac61271a0370b45444068c360b5 (diff)
Update README
-rw-r--r--README.md27
1 files changed, 23 insertions, 4 deletions
diff --git a/README.md b/README.md
index c1860ed..0377e32 100644
--- a/README.md
+++ b/README.md
@@ -6,19 +6,38 @@ weather information from any location in the world.
6The application uses the FOSS Open-Meteo API to retrieve this information 6The application uses the FOSS Open-Meteo API to retrieve this information
7without any API key or paid subscriptions to services like OpenWeatherMap. 7without any API key or paid subscriptions to services like OpenWeatherMap.
8 8
9# setup 9# Setup
10 10
11## clone the repository 11## Clone the repository
12``` 12```
13git clone https://git.chudnick.com/pywttr-docker 13git clone https://git.chudnick.com/pywttr-docker
14``` 14```
15## build the image 15## Build the image
16``` 16```
17cd pywttr-docker 17cd pywttr-docker
18docker build -t pywttr:latest . 18docker build -t pywttr:latest .
19``` 19```
20## run the container 20## Run the container
21``` 21```
22docker run -d -p 8000:8000 --name pywttr pywttr:latest 22docker run -d -p 8000:8000 --name pywttr pywttr:latest
23``` 23```
24 24
25# Usage
26
27Browse to the webpage at `host:8000` where `host` is the hostname of your docker server
28and `8000` is the external published port you chose during the setup.
29
30Enter either the name of a location or a postal code you want to see weather for.
31
32If your entry is unambiguous (i.e. it's a unique name or a postal code) you will be taken
33directly to the weather information.
34
35If a search for the location returns more than 1 result you will first be directed to
36select the location you want from a list of available choices.
37
38# Information
39
40Currently the application will return 3 sets of data:
41- Current weather data
42- Hourly weather data for the next 48 hours
43- Daily weather data for the next 7 days