From 7153ccbb57a7d8abc15b81218b12780c4a0e19db Mon Sep 17 00:00:00 2001
From: Niko Diamadis <niko@cyb3rko.de>
Date: Thu, 19 Dec 2024 23:02:31 -0500
Subject: [PATCH] docs: add info about FishFish

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

diff --git a/README.md b/README.md
index 4b67936..f16a645 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,7 @@
   - [URL Filter 🌐](#url-filter-)
   - [URL Phishing Check 🗡️](#url-phishing-check-)
     - [VirusTotal](#virustotal)
+    - [FishFish](#fishfish)
   - [planned] *File Type Filter* 📎
   - [planned] *File Virus Scan* 🦠
   - [planned] *Keyword Filter* 📄
@@ -43,6 +44,14 @@ The analysis can be powered by the following providers:
 VirusTotal allows scanning a full URL and returning a very comprehensive scan report.  
 Guardian rates a URL "suspicious" if the statistics `malicious` and `suspicious` have a combined score of 3 or more.
 
+#### FishFish
+
+**Reference**: https://fishfish.gg  
+**Activation (default: false)**: `GUARDIAN_URL_CHECK_FISHFISH: true|false`
+
+FishFish allows scanning a domain and returning a rating, if found in their reports.  
+Guardian rates a URL "suspicious" if the FishFish rating is `malware` or `phishing` rather than `safe`.
+
 ## Protected Public Rooms (Mentions)
 
 This list showcases some of the rooms who use the Matrix Guardian 🛡️: