diff options
| author | vaporii <124741890+vaporii@users.noreply.github.com> | 2025-01-26 16:55:53 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-01-26 14:55:53 -0800 |
| commit | bf7314702e04d3f353c4cf95e887959d9451641b (patch) | |
| tree | b7ee60047acd23f72ab58957bfc547dda0a35f98 | |
| parent | b6840e185615f3e938a78ebe0488fdf61694464d (diff) | |
Update README
| -rw-r--r-- | README.md | 24 |
1 files changed, 23 insertions, 1 deletions
@@ -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>`. |