aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md24
1 files changed, 23 insertions, 1 deletions
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>`.