# HG changeset patch
# User Matthew Wild <mwild1@gmail.com>
# Date 1665697737 -3600
# Node ID 7d33178c79f2f7796aea3147b40dc2335259a2b5
# Parent  53145c6b6b0bc555cdda39c1fc2cd053864d4889
mod_sasl2: Add some brief dev notes about events to the README

diff -r 53145c6b6b0b -r 7d33178c79f2 mod_sasl2/README.md
--- a/mod_sasl2/README.md	Thu Oct 13 22:48:28 2022 +0100
+++ b/mod_sasl2/README.md	Thu Oct 13 22:48:57 2022 +0100
@@ -5,3 +5,16 @@
 ---
 
 Experimental implementation of [XEP-0388: Extensible SASL Profile]
+
+## Developers
+
+mod_sasl2 provides some events you can hook to affect aspects of the
+authentication process:
+
+- `advertise-sasl-features`
+- `sasl2/c2s/success`
+  - Priority 1000: Session marked as authenticated, success response created (`event.success`)
+  - Priority -1000: Success response sent to client
+  - Priority -1500: Updated <stream-features/> sent to client
+- `sasl2/c2s/failure`
+- `sasl2/c2s/error`