From f4de339dafd0cdce1c9b84555e590abf0ef68253 Mon Sep 17 00:00:00 2001
From: Tom Scavo <trscavo@internet2.edu>
Date: Sat, 10 Jun 2017 22:31:08 -0400
Subject: [PATCH] Add example to Overview section
---
README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 53 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 5e1fdfd..2832297 100644
--- a/README.md
+++ b/README.md
@@ -60,7 +60,7 @@ Note: Some OSes define `TMPDIR` and some do not. In any case, a temporary direct
## Logging
-For convenience, we will log directly to the terminal:
+For convenience, we will log directly to the terminal in the examples below:
```Shell
$ export LOG_FILE=/dev/tty
@@ -82,6 +82,50 @@ The default logging level is INFO (i.e., if you do not explicitly set the option
## Overview
+First define a couple of HTTP resources and a cache:
+
+```Shell
+$ url1=http://md.incommon.org/InCommon/InCommon-metadata-preview.xml
+$ url2=http://md.incommon.org/InCommon/InCommon-metadata-fallback.xml
+$ export CACHE_DIR=/tmp/http_cache
+```
+
+### `request_http_resources.sh`
+
+Bash script `request_http_resources.sh` issues a HEAD request for one or more HTTP resources:
+
+```Shell
+$ $BIN_DIR/request_http_resources.sh -d /tmp/out $url1 $url2
+2017-06-11T02:26:26Z INFO request_http_resources.sh BEGIN
+2017-06-11T02:26:26Z INFO request_http_resources.sh requesting resource: http://md.incommon.org/InCommon/InCommon-metadata-preview.xml
+2017-06-11T02:26:26Z INFO request_http_resources.sh requesting resource: http://md.incommon.org/InCommon/InCommon-metadata-fallback.xml
+2017-06-11T02:26:26Z INFO request_http_resources.sh writing output file: http_response_headers.json
+2017-06-11T02:26:26Z INFO request_http_resources.sh moving output file to dir: /tmp/out
+2017-06-11T02:26:26Z INFO request_http_resources.sh END
+```
+
+The script produces a JSON array containing objects such as the following:
+
+```JavaScript
+ {
+ "successFlag": true,
+ "message": "Resource request successful",
+ "location": "http://md.incommon.org/InCommon/InCommon-metadata-preview.xml",
+ "ResponseCode": "200",
+ "Date": "Sun, 11 Jun 2017 02:16:44 GMT",
+ "LastModified": "Fri, 09 Jun 2017 19:05:16 GMT",
+ "ETag": "\"2a96bf6-5518ba65a0c50\"",
+ "ContentLength": "44657654",
+ "ContentType": "application/samlmetadata+xml"
+ }
+```
+
+See the inline help file for details:
+
+```Shell
+$ $BIN_DIR/request_http_resources.sh -h
+```
+
### `cget.sh`
Bash script `cget.sh` retrieves and caches HTTP resources on disk. A previously cached resource is retrieved via HTTP Conditional GET [RFC 7232]. If the web server responds with HTTP 200 OK, the resource is cached and written to stdout. If the web server responds with 304 Not Modified, the cached resource is output instead.
@@ -182,6 +226,14 @@ See the inline help file for details:
$ $BIN_DIR/cget.sh -h
```
+### `compute_md_vital_stats.sh`
+
+TBD
+
+### `test_compressed_resources.sh`
+
+TBD
+
## Compatibility
Shell scripts are compatible with both GNU/Linux and Mac OS. XSLT scripts are written in XSLT 1.0.