From a2523a5b53a1fcd25e9a554afbc8b1f34e2b96ab Mon Sep 17 00:00:00 2001 From: CJ van den Berg Date: Sun, 8 Mar 2026 20:11:18 +0100 Subject: [PATCH] docs: add some more platform support details to the readme --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7857046..ade2a53 100644 --- a/README.md +++ b/README.md @@ -35,12 +35,21 @@ It simply keeps watch. ## Features - Recursive directory tree tracking -- Deterministic multi-platform support (Linux, FreeBSD, MacOS, Windows) +- Deterministic multi-platform support (Linux, macOS, FreeBSD, OpenBSD, NetBSD, DragonFly BSD, Windows) - Lightweight and fast - Embeddable Zig module API - Standalone CLI executable ------------------------------------------------------------------------- +### Platform backends + +| Platform | Backend | Notes | +| --------------------------------------- | ------------------------------------------------------ | ------------------------------------------------------------------ | +| Linux | inotify | Threaded mode (default) or poll mode (`-Dlinux_read_thread=false`) | +| macOS | kqueue (default) or FSEvents (`-Dmacos_fsevents=true`) | FSEvents requires Xcode frameworks | +| FreeBSD, OpenBSD, NetBSD, DragonFly BSD | kqueue | | +| Windows | ReadDirectoryChangesW | | + +--- # Installation