Fix README
- Fix incorrect info on current API - Update To-do list
This commit is contained in:
parent
1270a3e595
commit
e03c85037e
20
README.md
20
README.md
@ -1,6 +1,6 @@
|
||||
# OpenWeatherWidget
|
||||
|
||||
Tiny desktop widget for weather updates using the [OpenWeatherMap](https://openweathermap.org) API.
|
||||
Minimal weather widget for your desktop updates using the [OpenWeatherMap](https://openweathermap.org) API.
|
||||
|
||||
## Status
|
||||
⚠️ Work in progress - not ready for general use.
|
||||
@ -24,17 +24,23 @@ units="metric"
|
||||
|
||||
## 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.
|
||||
- Currently uses the [Free API v2.5](https://openweathermap.org/appid). Find details on [Postman](https://www.postman.com/api-evangelist/openweathermap/request/9dt1g2m/call-current-weather-data-for-one-location).
|
||||
- [One Call API 3.0](https://openweathermap.org/api/one-call-3) is free for up to 1000 API calls per day, but requires payment information for subscription.
|
||||
- Support for student plan
|
||||
- Support for One Call v3.0 may be considered later.
|
||||
|
||||
## To-do
|
||||
|
||||
- [x] TOML configuration file
|
||||
- [x] Fetch and parse weather data from openweathermap.org
|
||||
- [x] Fetch and parse current weather data from openweathermap.org
|
||||
- [ ] Weather forecast query
|
||||
- [ ] Complete configuration
|
||||
- [ ] CLI args
|
||||
- [ ] GUI - [iced](https://book.iced.rs/)
|
||||
- [ ] Icons
|
||||
- [ ] Migrate to One Call API 3.0
|
||||
- [ ] Support One Call API 3.0
|
||||
|
||||
# Low-probability To-do
|
||||
|
||||
- [ ] Historical weather query
|
||||
- [ ] Weather maps
|
||||
|
Loading…
x
Reference in New Issue
Block a user