From 11de1ddfbbde171cfdf150093c95fb19038dffeb Mon Sep 17 00:00:00 2001
From: Daniel Saxton <2658661+dsaxton@users.noreply.github.com>
Date: Sat, 8 Mar 2025 07:30:07 -0600
Subject: [PATCH] Add blacklist docs

---
 README.md | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 4abe825..eb6288d 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,3 @@
-
 # noteguard
 
 A high performance note filter plugin system for [strfry]
@@ -107,6 +106,18 @@ The whitelist filter only allows notes to pass if it matches a particular pubkey
 
 Either criteria can match
 
+### Blacklist
+
+* name: `blacklist`
+
+The blacklist filter blocks notes that match any pubkey, ip, or CIDR range:
+
+- `pubkeys` *optional*: a list of hex public keys to block
+
+- `ips` *optional*: a list of IP addresses to block
+
+- `cidrs` *optional*: a list of CIDR ranges to block
+
 ### Kinds
 
 * name: `kinds`
@@ -155,7 +166,6 @@ be queued if the connection goes down (up to the `queue_size` buffer limit)
 
 - `queue_size` *optional* - size of the note queue, this is used to buffer notes if the connection goes down. Default is 1000.
 
-
 ## Testing
 
 You can test your filters like so: