From 60a3317817473bf1f0475cce56f00cf990dd9662 Mon Sep 17 00:00:00 2001 From: Tom Scavo Date: Mon, 17 Oct 2016 10:58:17 -0400 Subject: [PATCH] Add overview section --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index ede6324..4bcecd3 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,16 @@ http_tools.sh md_tools.sh ``` +## Overview + +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 written to stdout instead. + +See the inline help file for details: + +```Shell +$ $BIN_DIR/cget.sh -h +``` + ## Compatibility Shell scripts are compatible with both GNU/Linux and Mac OS. XSLT scripts are written in XSLT 1.0.