Skip to content

Commit d2eb482

Browse files
dbdeveloperclaude
andcommitted
docs: clarify event-listener role in README
The "Polling, not events" bullet was too absolute — it implied no listeners at all, which is no longer true. Pseudo-merge mode does register vault listeners, but strictly READ-ONLY ones whose only side effect is calling counter.markDirty() to refresh the UI badges. They never mutate sync state. Sync engine itself remains polling-driven (no missed-events failure mode). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent fb5e8ed commit d2eb482

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,15 @@ mid-range Android devices without OOM crashes.
104104
very first sync on a non-empty vault against a non-empty remote)
105105
never silently overwrites local files: it mtime-checks every
106106
divergence and keeps local when local is newer.
107-
- **Polling, not events.** The plugin walks the vault on each sync
108-
click instead of subscribing to live events, so edits made while
109-
the plugin was disabled are picked up on the next click — no
110-
"missed events" failure mode.
107+
- **Polling, not events — for the sync engine itself.** The plugin
108+
walks the vault on each sync click instead of subscribing to live
109+
events for sync purposes, so edits made while the plugin was
110+
disabled are picked up on the next click — no "missed events"
111+
failure mode. Vault event listeners *are* attached, but strictly
112+
read-only: they only refresh the pending-conflict counter (status
113+
bar 🔀 + ribbon badge) in real time so you see resolution
114+
progress immediately as you delete or rename sibling files. They
115+
never push, never pull, never mutate sync state.
111116
- **Click feels instant.** The click path writes the commit batch to
112117
disk and returns immediately; the network work happens in the
113118
background. Idle syncs stay silent; only heavy ones show a progress

0 commit comments

Comments
 (0)