about summary refs log tree commit diff
diff options
context:
space:
mode:
authorKevin Mandura <webmaster@kevin-mandura.de>2024-03-24 15:37:13 +0100
committerKevin Mandura <webmaster@kevin-mandura.de>2024-03-24 15:37:13 +0100
commit3304a22dc751b8649b1a96a9ec205bede3179bf6 (patch)
tree358dcb03eaa96d2ac4e8af193ce0fa7277798806
parent753e468eac4c545185ab7c809c1bdbb9c1de3440 (diff)
downloaddwm-status-sh-3304a22dc751b8649b1a96a9ec205bede3179bf6.tar.gz
dwm-status-sh-3304a22dc751b8649b1a96a9ec205bede3179bf6.zip
Update README rewrite
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4b881b9..e3c3514 100644
--- a/README.md
+++ b/README.md
@@ -66,6 +66,35 @@ be done using the 'autostart' patch for DWM, or by editing .xinitrc
 
 - [https://dwm.suckless.org/patches/autostart/](https://dwm.suckless.org/patches/autostart/)
 
+### Refreshing the weather status module
+
+For the current weather temperature and a description to show up in
+the status bar, you need to specify the API key for OpenWeatherMap in
+the script's configuration section before executing the script.
+
+To obtain such an API key, register for free at the OpenWeatherMap
+website:
+
+- [https://openweathermap.org](https://openweathermap.org)
+
+Also, weather information is only received and displayed by the
+script, if requested **manually**.
+
+To use the weather status module, make sure that the shell script is
+already running in the background, and then call another instance for
+refreshing the weather status module by executing:
+
+```
+./dwm-status.sh refresh-weather
+```
+
+You need to run this command every time, that you want to display the
+current, up-to-date weather information from OpenWeatherMap.
+
+For convenience, it is of course recommended, that you bind that
+command to a key kombination, or run it as a scheduled task if you
+prefer automation.
+
 ## License
 
 This script is licensed under the GNU General Public License version 3