aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRunxi Yu <me@runxiyu.org>2025-03-23 12:47:10 +0800
committerRunxi Yu <me@runxiyu.org>2025-03-23 12:47:10 +0800
commit911c932ec426ee45c9380bd26714c4bb505a3a88 (patch)
tree5224b91b5622997ccfc882c2e4e0b22e97bc450b /README.md
parentRevert "Remove the trivial habitual makefile" (diff)
downloadpowxy-911c932ec426ee45c9380bd26714c4bb505a3a88.tar.gz
powxy-911c932ec426ee45c9380bd26714c4bb505a3a88.tar.zst
powxy-911c932ec426ee45c9380bd26714c4bb505a3a88.zip
Use a global struct with version and source info
Diffstat (limited to '')
-rw-r--r--README.md14
1 files changed, 5 insertions, 9 deletions
diff --git a/README.md b/README.md
index 43f0feb..13492dc 100644
--- a/README.md
+++ b/README.md
@@ -23,20 +23,14 @@ a bit unnecessary.
- Currently we round times to the nearest week for persistence, but this could
cause issues if a user completes the challenge at the end of a rounded week.
-## Installation
+## Build
-You need a working Go installation. Then either
-
-```
-go install go.lindenii.runxiyu.org/powxy@latest
-```
-
-or
+You need a working Go installation.
```
git clone ssh://forge.lindenii.runxiyu.org/powxy/:/repos/powxy/
cd powxy
-go install
+make
```
## Usage
@@ -49,6 +43,8 @@ Usage of ./powxy:
address to listen on (default ":8081")
-secondary
trust X-Forwarded-For headers
+ -source string
+ url to the source code (default "https://https://forge.lindenii.runxiyu.org/powxy/:/repos/powxy/")
-upstream string
destination url base to proxy to (default "http://127.0.0.1:8080")
```