From d402fa3f02cfd09ac9f5b5ef3d860b7b76f6a792 Mon Sep 17 00:00:00 2001
From: CaffeineFueled <hello@uphillsecurity.com>
Date: Fri, 17 Oct 2025 23:34:52 +0200
Subject: [PATCH] ADD more installation instructions and clean up README #1

---
 README.md | 44 ++++++++++++--------------------------------
 1 file changed, 12 insertions(+), 32 deletions(-)

diff --git a/README.md b/README.md
index 02034cc..5fc6600 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,16 @@
 # Aukpad Paste Proxy
 
-This proxy allows the paste creation from temporary aukpads via linedump. Can be used as a 'GUI' for linedump.
-
-- Status: Beta - Docs missing, not suited for current linedump version
-
----
-
-## Features
-
-**Available**:
-
-**Ideas**:
-
-**Not planned**:
+This proxy allows the paste creation from temporary [aukpad](https://aukpad.com/) via [linedump](https://linedump.com/). Can be used as a 'GUI' for linedump.
 
 ---
 
 ## Usage
 
-- Create a pad in aukpad.
-- Change the domain of the pad from `aukpad.com` `bin.aukpad.com`
-- Create new paste in linedump instance and get redirected 
+- Create a pad in your aukpad instance of choice.
+- Replace the domain of the aukpad instance with the domain of the this proxy while leaving the {paste_id}- for example: https://aukpad.com/fef3 into https://bin.aukpad.com/fef3
+- This will create a paste on the chosen linedump instanec of this proxy.
+
+Information can be found on the root page of the proxy instance.
 
 ---
 
@@ -35,35 +25,25 @@ This proxy allows the paste creation from temporary aukpads via linedump. Can be
 | `PROXY_BASEURL` | This proxy's base URL for documentation including protocol | `https://bin.aukpad.com` |
 
 
-### Manual Container Run
+### Docker / Podman
 
 ```bash
-# Using variables
-$CONTAINER_CMD run --name ${CONTAINER_NAME} \
-    -p 127.0.0.1:${PORT_HOST}:${PORT_CONTAINER} \
-    -e PAD_BASEURL="${PAD_BASEURL}" \
-    -e DUMP_BASEURL="${DUMP_BASEURL}" \
-    -e PROXY_BASEURL="${PROXY_BASEURL}" \
-    --read-only \
-    --security-opt no-new-privileges:true \
-    --cap-drop ALL \
-    --user 1000:1000 \
-    -d ${IMAGE_NAME}:latest
-
 # Example with Podman
-podman run --name aukpad-paste-proxy \
+podman run -d --name aukpad-paste-proxy \
     --replace \
     -p 127.0.0.1:8001:8000 \
     -e PAD_BASEURL="https://aukpad.com" \
     -e DUMP_BASEURL="https://linedump.com" \
-    -e PROXY_BASEURL="http://127.0.0.1:8001" \
+    -e PROXY_BASEURL="https://bin.aukpad.com" \
     --read-only \
     --security-opt no-new-privileges:true \
     --cap-drop ALL \
     --user 1000:1000 \
-    -d localhost/aukpad-proxy:dev
+    git.uphillsecurity.com/cf7/aukpad-paste-proxy:latest
 ```
 
+_Replace 'podman' with 'docker'._
+
 ---
 
 ## Security