From d86f42d8ab1c2a34a3d0e8bd23f57aef6d8d670b Mon Sep 17 00:00:00 2001 From: Sam Chudnick Date: Sat, 10 Jun 2023 09:24:50 -0400 Subject: Update README --- README.md | 27 +++++++++++++++++++++++---- 1 file 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. The application uses the FOSS Open-Meteo API to retrieve this information without any API key or paid subscriptions to services like OpenWeatherMap. -# setup +# Setup -## clone the repository +## Clone the repository ``` git clone https://git.chudnick.com/pywttr-docker ``` -## build the image +## Build the image ``` cd pywttr-docker docker build -t pywttr:latest . ``` -## run the container +## Run the container ``` docker run -d -p 8000:8000 --name pywttr pywttr:latest ``` +# Usage + +Browse to the webpage at `host:8000` where `host` is the hostname of your docker server +and `8000` is the external published port you chose during the setup. + +Enter either the name of a location or a postal code you want to see weather for. + +If your entry is unambiguous (i.e. it's a unique name or a postal code) you will be taken +directly to the weather information. + +If a search for the location returns more than 1 result you will first be directed to +select the location you want from a list of available choices. + +# Information + +Currently the application will return 3 sets of data: +- Current weather data +- Hourly weather data for the next 48 hours +- Daily weather data for the next 7 days -- cgit v1.2.3