From 6c2101aad479152f783f755740b1258d3eb9aa8a Mon Sep 17 00:00:00 2001
From: Tom Scavo <trscavo@internet2.edu>
Date: Sun, 11 Jun 2017 09:30:11 -0400
Subject: [PATCH] Added a new example to the Overview section
---
README.md | 37 ++++++++++++++++++++++++++++++++++++-
1 file changed, 36 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 0b87310..8c8f30a 100644
--- a/README.md
+++ b/README.md
@@ -263,7 +263,42 @@ $ $BIN_DIR/compute_md_vital_stats.sh -h
### `test_compressed_resources.sh`
-TBD
+Bash script `test_compressed_resources.sh` tests one or more resources for HTTP Compression:
+
+```Shell
+$ $BIN_DIR/test_compressed_resources.sh -d /tmp/out $url1 $url2
+2017-06-11T13:20:39Z INFO test_compressed_resources.sh BEGIN
+2017-06-11T13:20:39Z INFO test_compressed_resources.sh requesting (compressed) resource: http://md.incommon.org/InCommon/InCommon-metadata-preview.xml
+2017-06-11T13:20:43Z INFO conditional_get reading cached content file: /tmp/http_cache/1e6b844a49d1850b82feded72cf83ed7_content
+2017-06-11T13:20:43Z INFO test_compressed_resources.sh requesting (compressed) resource: http://md.incommon.org/InCommon/InCommon-metadata-fallback.xml
+2017-06-11T13:20:45Z INFO conditional_get reading cached content file: /tmp/http_cache/1727196e5b7593f3b7528c539e7169d2_content
+2017-06-11T13:20:46Z INFO test_compressed_resources.sh writing output file: compressed_response_headers.json
+2017-06-11T13:20:46Z INFO test_compressed_resources.sh moving output file to dir: /tmp/out
+2017-06-11T13:20:46Z INFO test_compressed_resources.sh END
+```
+
+The script produces a JSON array containing objects such as the following:
+
+```JavaScript
+ {
+ "successFlag": true,
+ "message": "Integrity of compressed metadata confirmed",
+ "location": "http://md.incommon.org/InCommon/InCommon-metadata-preview.xml",
+ "ResponseCode": "200",
+ "Date": "Sun, 11 Jun 2017 13:10:37 GMT",
+ "LastModified": "Fri, 09 Jun 2017 19:05:16 GMT",
+ "ETag": "\"80bc05-5518ba65a1fd5\"",
+ "ContentLength": "8436741",
+ "ContentType": "application/samlmetadata+xml",
+ "ContentEncoding": "gzip"
+ }
+```
+
+Like the previous script, this script also depends on cached metadata. In addition, this script requests each (compressed) resource from the server just-in-time. See the inline help file for details:
+
+```Shell
+$ $BIN_DIR/test_compressed_resources.sh -h
+```
## Compatibility