From e7b18404683f26cd7132f0507cd1d6cc6b1cfba1 Mon Sep 17 00:00:00 2001 From: Valentine Date: Wed, 6 Jul 2022 01:29:01 +0100 Subject: [PATCH] Update README --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index e69de29..0e6684d 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,25 @@ +# whattp - A Simple, Offline, Easy to Use HTTP status code explorer. + +![whattp](/doc/static/whattpbanner.png) + +___ + + +`whattp` is a CLI developed using Go which allows you to quickly get information on a specific HTTP status code with a single command. + +## Installation + +`whattp` is distributed using Brew, so is only available to those with access to homebrew. + +To install `whattp` first tap the repo: +`brew tap valxntine/valxntine` + +Then install `whattp`: +`brew install whattp` + +## Usage + +Using `whattp` is a breeze, just use the HTTP status code you're interested in as the first and only argument to the command, for example: +`whattp 404` + +And you'll be greeted with an output explaining what that status code means.