From 210837a4040f735f29a163ed18b54bd66e31ecd0 Mon Sep 17 00:00:00 2001
From: Gianni Carafa <gianni.carafa@srf.ch>
Date: Thu, 2 Nov 2023 18:42:53 +0100
Subject: [PATCH] improve docs

---
 README.md | 37 +++++++++++++++++++++++++++++--------
 1 file changed, 29 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 3f22c6e..ba772fb 100644
--- a/README.md
+++ b/README.md
@@ -14,21 +14,22 @@ Certain sites may display missing images or encounter formatting issues. This ca
 
 ### Features
 - [x] Bypass Paywalls
-- [x] Remove CORS Headers from Responses, Assets, and Images ...
-- [x] Keep Site browsable
+- [x] Remove CORS headers from responses, Assets, and images ...
+- [x] Keep site browsable
 - [x] Add a debug path
 - [x] Add a API
-- [x] Docker Container
-- [x] Linux Binary
-- [x] Mac OS Binary
-- [x] Windows Binary (Untested)
+- [x] Docker container
+- [x] Linux binary
+- [x] Mac OS binary
+- [x] Windows binary (Untested)
+- [x] Remove most of the ads (unexpected side effect)
 - [ ] Basic Auth
 
 ## Installation
 
 ### Binary
-1) Download Binary
-2) Run Binary
+1) Download binary [here](https://github.com/kubero-dev/ladder/releases/latest)
+2) Unpack and run the binary `./ladder`
 3) Open Browser (Default: http://localhost:8080)
 
 ### Docker
@@ -42,6 +43,26 @@ wget https://raw.githubusercontent.com/kubero-dev/ladder/main/docker-compose.yml
 docker-compose up -d
 ```
 
+## Usage
+
+### Browser
+1) Open Browser (Default: http://localhost:8080)
+2) Enter URL
+3) Press Enter
+
+Or direct by appending the URL to the end of the proxy URL:
+http://localhost:8080/https://www.google.com
+
+
+
+### API
+```bash
+curl -X GET "http://localhost:8080/api/https://www.google.com"
+```
+
+### Debug
+http://localhost:8080/debug/https://www.google.com
+
 ## Configuration
 
 ### Environment Variables