Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
slaterslater authored Oct 1, 2020
1 parent 93c9719 commit 3d09ce8
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <https://www.python.org/downloads/>
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
Expand All @@ -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

0 comments on commit 3d09ce8

Please sign in to comment.