From bf7314702e04d3f353c4cf95e887959d9451641b Mon Sep 17 00:00:00 2001
From: vaporii <124741890+vaporii@users.noreply.github.com>
Date: Sun, 26 Jan 2025 16:55:53 -0600
Subject: Update README

---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 0fc9f96..bef2363 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ Just something I threw together real quick for an incredibly specific and niche
 
 ## Usage
 - Create `~/.status/auth`
-- Run the server
+- Run the server (see compilation instructions below)
 - Make requests to `/generate-hash` to create user and admin hashes
     - With cURL: `curl -u username:password <address>/generate-hash`
 - Put generated hashes into `~/.status/auth`
@@ -15,3 +15,25 @@ Just something I threw together real quick for an incredibly specific and niche
     - With cURL: `curl -u username:password <address>`
 
 If that seems incredibly janky, that's because it is :3
+
+## Compiling
+Requirements
+- go >= 1.22.5
+
+Instructions:
+1. Clone the repo
+```bash
+git clone https://github.com/CartConnoisseur/status
+cd status
+```
+2. Install dependencies
+```bash
+go mod tidy
+```
+
+3. Compile
+```bash
+go build -o status
+```
+
+The server can then be run via `./status <port>`.
-- 
cgit v1.2.3