From 4b5f67d473c8986e0d1c6a97e8e2da53da91ad27 Mon Sep 17 00:00:00 2001 From: William Casarin Date: Tue, 9 Jul 2024 09:55:41 -0700 Subject: [PATCH] readme: add optional indicator to filter docs Signed-off-by: William Casarin --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e1a9a41..998e50c 100644 --- a/README.md +++ b/README.md @@ -39,15 +39,15 @@ Settings: - `notes_per_minute`: the number of notes per minute which are allowed to be written per ip. -- `whitelist`: a list of IP4 or IP6 addresses that are allowed to bypass the ratelimit. +- `whitelist` *optional*: a list of IP4 or IP6 addresses that are allowed to bypass the ratelimit. ### Whitelist The whitelist filter only allows notes to pass if it matches a particular pubkey or source ip: -- `pubkeys`: a list of hex public keys to let through +- `pubkeys` *optional*: a list of hex public keys to let through -- `ips`: a list of ip addresses to let through +- `ips` *optional*: a list of ip addresses to let through Either criteria can match