From: Ardis Lu <ardisglu@gmail.com>
Date: Tue, 5 Dec 2023 05:35:14 +0000 (-0800)
Subject: Add warning about using pwned worker
X-Git-Url: https://git.ardis.lu/?a=commitdiff_plain;h=62a6107133473cc35fb1b21ba7aff244efc0bd2b;p=cloudflare-workers

Add warning about using pwned worker
---

diff --git a/README.md b/README.md
index 3e64430..b994ae3 100644
--- a/README.md
+++ b/README.md
@@ -172,6 +172,12 @@ https://x.y.workers.dev?https://example.com
 
 ## pwned
 
+> [!CAUTION]<br> The underlying Pwned Passwords API used in this worker uses a
+> [_k_-anonymity model](https://en.wikipedia.org/wiki/K-anonymity) to preserve
+> your privacy. This worker negates that benefit. This worker should only be
+> referenced for education, not actually used in a production backend.<br><br>
+> [Click here to read more.](https://www.troyhunt.com/ive-just-launched-pwned-passwords-version-2/#cloudflareprivacyandkanonymity)
+
 Checks a password against the [have i been pwned?](https://haveibeenpwned.com/)
 API and returns a boolean indicating if the password has been pwned or not. This
 is a simplified implementation of the