From e74f912332df969781a698dc3c693fec313a54c5 Mon Sep 17 00:00:00 2001
From: Davide Vaghetti <davide.vaghetti@garr.it>
Date: Thu, 2 Nov 2017 09:36:10 +0100
Subject: [PATCH] Updated README.md
---
README.md | 20 +++++++++++++++++++-
1 file changed, 19 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 43d2cfb..6994d8f 100644
--- a/README.md
+++ b/README.md
@@ -8,11 +8,29 @@ The script use only core python libraries to lessen the dependencies.
## Usage
-~~~
+~~~bash
./update-remote-ids.py [--no-cert] DISCOFEED_URL OUTFILE
~~~
The `--nocert` option is used to skip certificate validation
in HTTPS DISCOFEED_URLs.
+## Examples
+
+Running the script along with a Shibboleth Service Provider and a valid
+HTTPS endpoint:
+
+~~~bash
+./update-remote-ids.py https://KEYSTONE_URL/Shibboleth.sso/DiscoFeed /tmp/remote_ids
+~~~
+
+The file `/tmp/remote_ids` will be populated with the available IdP entityIDs:
+
+~~~json
+{"identity_provider":
+ {"remote_ids":
+ [ entityID, ... ]
+ }
+}
+~~~
--
GitLab