From 812ea6c44777a8e98b2b5f176dad8d7e90442ebc Mon Sep 17 00:00:00 2001
From: Nils <nils@byreqz.de>
Date: Sat, 29 May 2021 18:31:23 +0200
Subject: [PATCH] tweaked readme

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5dac752..e4e2de5 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,28 @@
 # netdiscover-docker
-dockerized mac-adress monitoring 
+this container will expose a netdiscover instance via http
+currently supported (optional) arguments are:
+
+- port // specifies the port (def. 8080)
+- userpass // sets http basic auth - ex. user:pass (def. none)
+- title // sets tab title (def. netdiscover-docker)
+
+
+# docker compose
+```yaml
+version: '2.3'
+
+services:
+  netdiscover-docker:
+    container_name: netdiscover-docker
+    network_mode: host
+    image: byreqz/netdiscover-docker:latest
+    restart: unless-stopped
+#    environment:
+#     - port=1234
+#     - userpass=user:pass
+#     - title=1234
+```
+
+# credits
+Netdiscover: https://github.com/netdiscover-scanner/netdiscover <br>
+GoTTY: https://github.com/yudai/gotty