From cc278e9e926e517ebbf40c7a219d06369c95880a Mon Sep 17 00:00:00 2001
From: aceberg <1502200+aceberg@users.noreply.github.com>
Date: Tue, 23 Aug 2022 22:33:08 +0700
Subject: [PATCH] README: quick start

---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 49 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 7e2249d..e4cc3bd 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,53 @@
 [![Docker](https://github.com/aceberg/WatchYourLAN/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/aceberg/WatchYourLAN/actions/workflows/docker-publish.yml)
 ![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/aceberg/watchyourlan)
 
-Local network IP scanner with web gui
+Lightweight local network IP scanner with web gui
 
-Work in progress..
\ No newline at end of file
+## Quick start
+
+Replace `$YOURTIMEZONE` with correct time zone and `$YOURIFACE` with network interface you want to scan. Network mode must be `host`.
+
+```sh
+docker run --name wyl \
+	-e "IFACE=$YOURIFACE" \
+	-e "TZ=$YOURTIMEZONE" \
+	--network="host" \
+    aceberg/watchyourlan
+```
+
+Set `$DOCKERDATAPATH` for container to save data:
+
+```sh
+docker run --name wyl \
+	-e "IFACE=$YOURIFACE" \
+	-e "TZ=$YOURTIMEZONE" \
+	--network="host" \
+	-v $DOCKERDATAPATH/wyl:/data \
+    aceberg/watchyourlan
+```
+Web GUI should be at http://localhost:8840
+
+## Config
+
+
+Configuration can be done through config file or environment variables
+
+| Variable  | Description | Default |
+| --------  | ----------- | ------- |
+| IFACE     | Interface to scan. Could be one or more, separated by space. Currently `docker0` is not allowed, as arp-scan wouldn't work with it correctly | enp1s0 |
+| DBPATH    | Path to Database | /data/db.sqlite |
+| GUIIP     | Address for web GUI | localhost (127.0.0.1) |
+| GUIPORT   | Port for web GUI | 8840 |
+| TIMEOUT   | Time between scans (seconds) | 60 (1 minute)|
+
+## Config file
+
+Config file path is `/data/config`.
+All variables could be set there. Exmple:
+```sh
+IFACE="enp2s0 wg0"
+DBPATH="/data/hosts.db"
+GUIIP="192.168.2.1"     # To access from LAN
+GUIPORT="8840"
+TIMEOUT="300"           # 5 minutes
+```
\ No newline at end of file