diff --git a/README.md b/README.md index dbffd1d..6b2fa2a 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Minimal weather widget for your desktop updates using the [OpenWeatherMap](https://openweathermap.org) API. ## Status -⚠️ Work in progress - not ready for general use. +⚠️ Work in progress - not ready for regular use. ## Configuration The widget reads configuration from: @@ -15,13 +15,33 @@ The widget reads configuration from: Example: ```toml -[general] -api_version = "free_2.5" # Other APIs are WIP +# General configs section +[general] +# API version. +# Available options: "free_2.5" (default), "onecall_3.0" (WIP) +# Other APIs are WIP +api_version = "free_2.5" +# Path to cache file. +# Default: ~/.cache/candydesktop/owm_widget.json +cache_file = "/path/to/file" + +# Query parameters section [query_params] -api_key = "your_api_key_here" # Get a free API key from https://openweathermap.org -city_id = "your_city_id_here" # Find it in the url of your city at https://openweathermap.org/find? -units = "metric" +# API key. +# Get a free API key from https://openweathermap.org +api_key = "your_api_key_here" + +# Location parameters. +# One of these must be specified: `city_name`, `city_id`, `lat` + `lon` pair, or `zip` +# `lat=` must always be paired with `lon=` +# Find your city id in the url of your city at https://openweathermap.org/find? +city_id = "5391959" # Example: San Francisco, US + +# Measurement units: `standard` (Kelvin, default), `imperial` (Fahrenheit), `metric` (Celcius) +units = "metric" + +# Language. Default: "en" (English) lang = "en" ```` ⚠️ WIP - Full configuration format will be released later. @@ -38,14 +58,29 @@ lang = "en" - [x] TOML configuration file - [x] Fetch and parse current weather data from OWM - [ ] Weather forecast query -- [ ] Complete library +- [ ] Complete library crate [(WIP)](https://git.candifloss.cc/candifloss/OpenWeatherMapSDK) - [ ] Complete configuration - [ ] CLI args - [ ] GUI - ~~[iced](https://book.iced.rs/)~~ [Slint](https://docs.slint.dev/latest/docs/slint/) + - Weather info: + - [x] Cureent weather + - [ ] Forecast + - [ ] Alerts and details + - Platforms: + - [x] X11 + - [ ] Wayland + - Tested on: + - [LeftWM](https://github.com/leftwm/leftwm) + - Ubuntu/Gnome on xorg - [ ] Icons - [ ] Support One Call API 3.0 +- Components: + - [x] Daemon + - [x] GUI widget + - [ ] TUI client + - [ ] CLI client -# Low-probability To-do +## Low-probability To-do - [ ] Historical weather query -- [ ] Weather maps +- [ ] Weather maps