Skip to content

Commit 2511422

Browse files
authored
docs: add install instructions
1 parent 40c1804 commit 2511422

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,42 @@
99
</div>
1010

1111
## The Problem
12-
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.
12+
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.
1313

1414
turns out I was getting trolled...
1515

1616
<img width="500px" src="./assets/http_cat_418.png">
1717

18+
anyways now I can get these hypertext transfer protocol kitties right from a terminal ⛱️ ☺️
19+
20+
## How to install from soruce.
21+
> [!WARNING]
22+
> Currently only added Linux support as I'm too lazy rn 😪 😴
23+
24+
1. Clone and cd into the repo.
25+
```sh
26+
git clone https://github.com/THEGOLDENPRO/http-cat-cli
27+
cd http-cat-cli
28+
```
29+
2. Build the Go project.
30+
```sh
31+
make
32+
```
33+
3. Install the binary.
34+
```sh
35+
make install
36+
```
37+
4. Done ✨
38+
```sh
39+
http-cat 100
40+
```
41+
<img width="500px" src="./assets/http_cat_100.png">
42+
1843
## Powered by the HTTP Cats API 🌟
1944
The command line interface is brought to you by **https://http.cat/**.
2045

2146
Of course I am not affiliated with them...
2247

23-
2448
> Section 1: Meow Disclaimer Meow
2549
>
2650
> 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");

0 commit comments

Comments
 (0)