readme

1 files changed, 27 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..4d7abfd
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,27 @@
+# trash-proxy
+
+A really bad minecraft reverse proxy for authentification of offline clients.
+
+Supported version: 1.19.2
+
+Whenever a client connects, the username is checked against all tokens in the
+whitelist, the first match will determine the username you log in as.
+
+## Usage
+
+- Install with `cargo install --path .`
+- Write configuration to `./proxy.yaml`
+- Run `trash-proxy`
+
+## Example configuration
+
+```
+protocol: 760
+backend: 127.0.0.1:25567
+bind: 0.0.0.0:25565
+whitelist:
+  - username: Steve
+    token: veryverysecret
+  - username: Alex
+    token: hunter2
+```