From 2511422025c9fef0c6fd51601c8f764ae401032c Mon Sep 17 00:00:00 2001
From: Goldy <66202304+THEGOLDENPRO@users.noreply.github.com>
Date: Sun, 18 Aug 2024 17:32:25 +0100
Subject: [PATCH 1/2] docs: add install instructions
---
README.md | 28 ++++++++++++++++++++++++++--
1 file changed, 26 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index a181318..55b67a2 100644
--- a/README.md
+++ b/README.md
@@ -9,18 +9,42 @@
## The Problem
-I was working on the backend of a web project of mine and I forgot what the HTTP status code `418` was so instead of opening a web browser I of course used this as an excuse to write my very first golang project.
+I was working on the backend of a web project of mine and I forgot what the HTTP status code `418` was, so instead of opening a web browser I of course used this as an excuse to write my very first golang project.
turns out I was getting trolled...
+anyways now I can get these hypertext transfer protocol kitties right from a terminal β±οΈ βΊοΈ
+
+## How to install from soruce.
+> [!WARNING]
+> Currently only added Linux support as I'm too lazy rn πͺ π΄
+
+1. Clone and cd into the repo.
+```sh
+git clone https://github.com/THEGOLDENPRO/http-cat-cli
+cd http-cat-cli
+```
+2. Build the Go project.
+```sh
+make
+```
+3. Install the binary.
+```sh
+make install
+```
+4. Done β¨
+```sh
+http-cat 100
+```
+
+
## Powered by the HTTP Cats API π
The command line interface is brought to you by **https://http.cat/**.
Of course I am not affiliated with them...
-
> Section 1: Meow Disclaimer Meow
>
> WHEREAS, it has come to the attention of the undersigned party, hereto referred to as "The Unaffiliated Entity," that there exists an entity, website, or digital repository of feline-themed HTTP status codes known to the general public and the World > Wide Web as "https://http.cat" (hereinafter referred to as "HTTP.cat" or "The Cat Site");
From bb68d970c2defb6b1424fa663bf064d0f1738434 Mon Sep 17 00:00:00 2001
From: Goldy <66202304+THEGOLDENPRO@users.noreply.github.com>
Date: Sun, 18 Aug 2024 17:36:33 +0100
Subject: [PATCH 2/2] docs: add required dependencies
---
README.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/README.md b/README.md
index 55b67a2..05c9060 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,10 @@ anyways now I can get these hypertext transfer protocol kitties right from a ter
> [!WARNING]
> Currently only added Linux support as I'm too lazy rn πͺ π΄
+### Required Prerequisites
+- [golang](https://go.dev/)
+- [chafa](https://github.com/hpjansson/chafa) (used for image displaying)
+
1. Clone and cd into the repo.
```sh
git clone https://github.com/THEGOLDENPRO/http-cat-cli