From 3d09ce85ec16164ad8e459ca3ad50157640bf318 Mon Sep 17 00:00:00 2001 From: slaterslater Date: Thu, 1 Oct 2020 16:34:03 -0400 Subject: [PATCH] Update README.md --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0bbc126..dbef4c6 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ ## Get-Url-Status (GUS) Text-As-Visual-Output (TAVO) -GUS is a command line tool that searches a file for all HTTP urls then prints a colourized report of their status +GUS is a command line tool that searches a file for all HTTP urls then prints a colourized report of their status. ### Requirements 1. Your system will need to have python 3 installed. You can find the latest release at 2. Download or clone this repo 3. Open a terminal ### Usage -GUS can be used from the command line or python shell\ -The location to a source file must be supplied +GUS can be used from the command line or python shell.\ +The location to a source file must be supplied. #### From the command line ``` python gus.py example.html @@ -16,3 +16,14 @@ python gus.py example.html >>> import gus >>> gus.tavo('example.html') ``` +### Results +GUS makes an HTTP connection for each URL in the source file.\ +The header is requested and the response code determines which label will be applied: +* 2xx is [GOOD] +* 4xx is [WARN] +* All other codes will be marked as [UNKN] + +GUS generates **output.rft** as a list of results colourized as follows: +* [GOOD] is green +* [WARN] is red +* [UNKN] is grey