add note official doc.

xward · Oct 15, 2023 · 317c3be · 317c3be
1 parent 24c4855
commit 317c3be
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -34,6 +34,15 @@ High performance application-layer DDoS protection for Elixir Phoenix.
 - [Later in roadmap](#later-in-roadmap)
 - [Contributing](#contributing)
 
+---
+
+**Note** _This README is for the unreleased main branch, please reference the
+[official documentation on hexdocs][hexdoc] for the latest stable release._
+
+[hexdoc]: https://hexdocs.pm/phoenix_ddos/PhoenixDDoS.html
+
+---
+
 # Features
 
 - **protection: ip safelist_ips** - List of ip that bypass all checks