From 1c36ef0dcdce773e04aea6d09cabae3d1dab661a Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Sun, 23 Mar 2025 11:52:35 +0800 Subject: Reorganize README --- README.md | 40 +++++++++++++++++++++++++++++++++++----- 1 file changed, 35 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c12bed9..43f0feb 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,6 @@ I intend to remove this in the near future and set up an actual demo instance on somewhere sensible; forge.runxiyu.org doesn't get much bot traffic so it's a bit unnecessary. -## Credits - -Inspired by [Anubis](https://github.com/TecharoHQ/anubis). But much simpler. - ## Bugs - **The cryptography hasn't been audited.** I wrote this after a tiring school @@ -27,7 +23,37 @@ Inspired by [Anubis](https://github.com/TecharoHQ/anubis). But much simpler. - 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. -## Contributing +## Installation + +You need a working Go installation. Then either + +``` +go install go.lindenii.runxiyu.org/powxy@latest +``` + +or + +``` +git clone ssh://forge.lindenii.runxiyu.org/powxy/:/repos/powxy/ +cd powxy +go install +``` + +## Usage + +``` +Usage of ./powxy: + -difficulty uint + leading zero bits required for the challenge (default 17) + -listen string + address to listen on (default ":8081") + -secondary + trust X-Forwarded-For headers + -upstream string + destination url base to proxy to (default "http://127.0.0.1:8080") +``` + +## Contribute Create a branch that begins with `contrib/` and push to [the repo on our home forge](https://forge.lindenii.runxiyu.org/powxy/:/repos/powxy/) @@ -47,6 +73,10 @@ git push -u origin HEAD on [irc.runxiyu.org](https://irc.runxiyu.org/). +## Credits + +Inspired by [Anubis](https://github.com/TecharoHQ/anubis). But much simpler. + ## License We are currently using the -- cgit v1.2.3