From 313a5c6b4167b6c6d9ab1feaa98136b7dcdff81d Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Sun, 23 Mar 2025 10:09:13 +0800 Subject: Update README --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index dd2521d..c7f359a 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ 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 week + and this definitely needs some review. - If a user is attempting to submit a POST request but their powxy cookie is invalid, powxy would redirect them to a challenge, and their POST data will be lost. @@ -19,8 +21,24 @@ Inspired by [Anubis](https://github.com/TecharoHQ/anubis). But much simpler. - We should probably use [net/http/httputil.NewSingleHostReverseProxy](https://pkg.go.dev/net/http/httputil#NewSingleHostReverseProxy) instead of hand-wiring a half-broken proxy. -- We should probably add a JS/WASM version for browsers that support them. -- We should limit the request size. + +## Contributing + +Create a branch that begins with `contrib/` and push via SSH. + +``` +git clone https://forge.lindenii.runxiyu.org/powxy/:/repos/powxy/ +cd powxy +git checkout -b contrib/whatever +# edit and commit stuff +git push -u origin HEAD +``` + +## Support + +[`#chat`](https://webirc.runxiyu.org/kiwiirc/#chat) +on +[irc.runxiyu.org](https://irc.runxiyu.org/). ## License -- cgit v1.2.3