aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-02-21 07:06:50 -0600
committerCraig Jennings <c@cjennings.net>2026-02-21 07:11:03 -0600
commitb74b98f177d92d50ddbede900ba41212e07c5f63 (patch)
tree459b1630dcc7d1c941f850565acdc16332831948 /README.org
parentec8130cfe1a7390e9939b311c8db39907a3f7f44 (diff)
downloademacs-wttrin-b74b98f177d92d50ddbede900ba41212e07c5f63.tar.gz
emacs-wttrin-b74b98f177d92d50ddbede900ba41212e07c5f63.zip
feat: unified cache and staleness handling for mode-line and buffer
Replace TTL-based cache invalidation with proactive scheduled refresh. Both mode-line and buffer systems now follow: timer refreshes cache, display reads from cache, staleness indicated when data is old. Phase 1 - Mode-line cache formalization + staleness display: - Replace wttrin--mode-line-tooltip-data with wttrin--mode-line-cache as (timestamp . data) cons cell matching buffer cache pattern - Add wttrin--format-age helper for human-readable age strings - Rewrite wttrin--mode-line-update-display to take no arguments, read from cache, compute staleness (age > 2x refresh interval), dim emoji gray when stale, show staleness info in tooltip - Rewrite wttrin--mode-line-fetch-weather to write cache on success, show stale display on failure with cache, error placeholder without - Add wttrin--mode-line-update-placeholder-error for first-launch failure Phase 2 - Remove TTL, add proactive buffer refresh: - Rename wttrin-cache-ttl to wttrin-refresh-interval (default 3600s) with define-obsolete-variable-alias for backward compatibility - Change wttrin-mode-line-refresh-interval default from 900 to 3600 - Remove TTL check from wttrin--get-cached-or-fetch; serve cached data regardless of age, background timer keeps it fresh - Add buffer refresh timer (wttrin--buffer-cache-refresh) Phase 3 - Buffer staleness display: - Add wttrin--format-staleness-header for buffer age display - Insert staleness line in wttrin--display-weather before instructions Phase 4 - Cleanup: - Remove all references to wttrin--mode-line-tooltip-data - Update README.org cache settings and mode-line documentation - Update tests for new API (198 tests across 21 files, all passing)
Diffstat (limited to 'README.org')
-rw-r--r--README.org14
1 files changed, 7 insertions, 7 deletions
diff --git a/README.org b/README.org
index d7ebd72..9f1180a 100644
--- a/README.org
+++ b/README.org
@@ -171,15 +171,15 @@ Wttrin's default is to select the unit system appropriate for the location you q
#+end_src
*** Cache Settings
-Wttrin caches weather data to reduce API calls and improve responsiveness. The cache holds data for 15 minutes by default, with a maximum of 50 entries. If you're checking weather frequently or want longer cache times, you can adjust these:
+Wttrin caches weather data and proactively refreshes it in the background. By default, the cache refreshes every hour, with a maximum of 50 entries. You can adjust these:
#+begin_src emacs-lisp
- (setq wttrin-cache-ttl (* 30 60)) ;; Cache for 30 minutes (in seconds)
- (setq wttrin-cache-max-entries 100) ;; Store up to 100 cached locations
+ (setq wttrin-refresh-interval (* 30 60)) ;; Refresh every 30 minutes (in seconds)
+ (setq wttrin-cache-max-entries 100) ;; Store up to 100 cached locations
#+end_src
*** Mode-line Weather Display
-Wttrin can display current weather for your favorite location directly in the mode-line. The weather updates automatically in the background every 15 minutes, showing a color emoji weather icon with full details on hover.
+Wttrin can display current weather for your favorite location directly in the mode-line. The weather updates automatically in the background every hour, showing a color emoji weather icon with full details on hover.
**** Basic Setup
To enable the mode-line weather display, set your favorite location and enable auto-start:
@@ -204,7 +204,7 @@ Alternatively, you can manually toggle the mode-line display:
- *Tooltip*: Hover for full details (location, temperature, conditions)
- *Left-click*: Open full weather buffer for your favorite location
- *Right-click*: Force refresh the weather data immediately
-- *Auto-refresh*: Updates every 15 minutes automatically
+- *Auto-refresh*: Updates every hour automatically
**** Customization
You can customize several aspects of the mode-line weather display:
@@ -216,8 +216,8 @@ You can customize several aspects of the mode-line weather display:
;; Auto-enable mode-line weather on startup
(setq wttrin-mode-line-auto-enable t)
- ;; Adjust refresh interval (in seconds, default is 900 = 15 minutes)
- (setq wttrin-mode-line-refresh-interval (* 10 60)) ;; Refresh every 10 minutes
+ ;; Adjust refresh interval (in seconds, default is 3600 = 1 hour)
+ (setq wttrin-mode-line-refresh-interval (* 30 60)) ;; Refresh every 30 minutes
;; Choose emoji font for color display (common options)
(setq wttrin-mode-line-emoji-font "Apple Color Emoji") ;; macOS