From 2c9d80a4051f18d4eb046e6d99d5cde2ac1837d1 Mon Sep 17 00:00:00 2001 From: Candifloss Date: Thu, 18 Sep 2025 23:22:26 +0530 Subject: [PATCH] Update README --- README.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b53a816..9817a88 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,39 @@ # OpenWeatherWidget -Tiny desktop widget for weather updates using the OpenWeatherMap API \ No newline at end of file +Tiny desktop widget for weather updates using the [OpenWeatherMap](https://openweathermap.org) API. + +## Status +⚠️ Work in progress - not ready for general use. + +## Configuration +The widget reads configuration from: + +``` +~/.config/candywidgets/openweathermap.toml +```` + +Example: + +```toml +[general] +api_key = "your_api_key_here" # get a free API key from https://openweathermap.org +city_id = "your_city_id_here" # Find at https://openweathermap.org/find? +units="metric" +```` +⚠️ WIP - Full configuration format will be released later. + +## API + +* Currently uses **Weather API v2.5**. +* While this API is deprecated in favor of [One Call API 3.0](https://openweathermap.org/api/one-call-3), it still works as of today. +* One Call API 3.0 is free for up to 1000 API calls per day, but requires payment information for subscription. +* Migration to v3.0 may be considered later. + +## To-do + +- [ ] TOML configuration file +- [ ] Fetch and parse weather data from openweathermap.org +- [ ] Complete configuration +- [ ] CLI args +- [ ] GUI - [iced](https://book.iced.rs/) +- [ ] Migrate to One Call API 3.0