Add notice about SSL to readme

vrslev · Aug 25, 2024 · c844a17 · c844a17
1 parent 3bce385
commit c844a17
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -29,6 +29,9 @@ async with stompman.Client(
     on_error_frame=lambda error_frame: print(error_frame.body),
     on_heartbeat=lambda: print("Server sent a heartbeat"),
 
+    # SSL — can be either `None` (default), `True`, or `ssl.SSLContext'
+    ssl=None,
+
     # Optional parameters with sensible defaults:
     heartbeat=stompman.Heartbeat(will_send_interval_ms=1000, want_to_receive_interval_ms=1000),
     connect_retry_attempts=3,