From 134c07ebdb89e1434f62392ea0f6e09570e8b0d7 Mon Sep 17 00:00:00 2001
From: Benjamin Dweck <bjdweck@gmail.com>
Date: Wed, 5 Jan 2022 09:59:57 +0200
Subject: [PATCH] Updated README.md docs

---
 README.md | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 5e91e29..52adf12 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,15 @@ Tor Proxy
 
 This is a Tor Proxy Docker container for "torifying" other Docker-based services in a Docker Compose project.  It creates a Tor Hidden Service with an onion hostname that persists as long as it's underlying storage volume.  The Tor Hidden Service listens on the specified port and proxies traffice to the specified target host:port.
 
-### Example Usage
+## Usage
+
+### Arguments
+
+- `SVC_LISTEN_PORT`: Port that the Tor hidden service will listen on for requests from the Tor network
+- `SVC_TARGET_HOST`: Target host for Tor traffic
+- `SVC_TARGET_PORT`: Target port on the target host
+
+### Sample `docker-compose.yml`
 
 `docker-compose.yml`:
 ```
@@ -11,7 +19,7 @@ This is a Tor Proxy Docker container for "torifying" other Docker-based services
 
   mysvc_tor_proxy:
     build:
-      context: ./tor
+      context: ./tor-proxy
       args:
         - SVC_LISTEN_PORT=80
         - SVC_TARGET_HOST=mysvc
@@ -24,3 +32,11 @@ This is a Tor Proxy Docker container for "torifying" other Docker-based services
 
 ...
 ```
+
+### Service Onion Hostname
+
+You can get the onion hostname of the proxy using the following command:
+
+```
+user@host:~$ docker-compose exec mysvc_tor_proxy svc-hostname
+```