From 85cfb390a7de312b4642702c54b7fd59a5ad5c51 Mon Sep 17 00:00:00 2001
From: Tom Scavo <trscavo@internet2.edu>
Date: Mon, 19 Dec 2016 19:50:10 -0500
Subject: [PATCH] Document probe_saml_idp.sh

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

diff --git a/README.md b/README.md
index 88bee2b..3d80e0d 100644
--- a/README.md
+++ b/README.md
@@ -92,6 +92,8 @@ $ $BIN_DIR/check_idp_error_urls.sh -h
 
 ### ``probe_saml_idp.sh``
 
+Given a single IdP entityID, the ``probe_saml_idp.sh`` script probes all browser-facing SSO endpoints in IdP metadata.
+
 ```Shell
 $ id=https://idp.incommonfederation.org/idp/shibboleth
 $ $BIN_DIR/probe_saml_idp.sh -a $id
@@ -100,6 +102,14 @@ $ $BIN_DIR/probe_saml_idp.sh -a $id
 0 redirects:2;response:200;dns:0.000;tcp:0.062;ssl:0.142;total:1.070 https://idp.incommonfederation.org/idp/profile/Shibboleth/SSO urn:mace:shibboleth:1.0:profiles:AuthnRequest https://idp.incommonfederation.org/idp/shibboleth https://incommon.org
 ```
 
+The ``-a`` option probes **all** browser-facing endpoints, including SAML1 endpoints.
+
+See the inline help file for details:
+
+```Shell
+$ $BIN_DIR/probe_saml_idp.sh -h
+```
+
 ## Compatibility
 
 The bash scripts are compatible with both GNU/Linux and Mac OS. The XSLT scripts are written in XSLT 1.0.