From ec29d6eda97ce1e9d4121c6c19f91d12ec25947c Mon Sep 17 00:00:00 2001
From: Sam Scholten
Date: Fri, 24 Oct 2025 16:36:57 +1000
Subject: Update documentation for v2.1.0 resampling feature

---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 2b52ac5..424b7ee 100644
--- a/README.md
+++ b/README.md
@@ -43,8 +43,12 @@ results = detect_from_wfm(
     name="data.Wfm.bin",
     sampling_interval=5e-7,  # seconds
     data_path="/path/to/data/",
+    target_sampling_interval=5e-6,  # Optional: downsample to 200 kHz
     detection_snr=3.0,
 )
+```
+
+**New in v2.1.0**: Use `target_sampling_interval` to downsample oversampled data before detection. This improves SNR and processing speed for high-frequency data.
 
 events = results["events"]
 print(f"Found {len(events)} events")
-- 
cgit v1.2.3