From 8f7148e4f5a68e8058a9ff2ffb391983d1865a74 Mon Sep 17 00:00:00 2001
From: Robert Kaussow <mail@geeklabor.de>
Date: Sun, 31 May 2020 21:54:12 +0200
Subject: [PATCH] add instructions to readme

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index 31e23ae..ba74180 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,30 @@
 
 Simple wrapper for [broken-link-checker](https://github.com/stevenvachon/broken-link-checker) optimized for CI.
 
+## Usage
+
+```Shell
+docker run -v $(pwd)/public:/drone/src link-validator
+
+# or pass arguments to broken-link-checker
+# ... but DO NOT set the server url! This will be done automatically. See environment variables.
+docker run -v $(pwd)/public:/drone/src link-validator -ro
+```
+
+## Environment variables
+
+```Shell
+LINK_VALIDATOR_BASE_DIR=/drone/src
+LINK_VALIDATOR_SERVER_ADDRESS=127.0.0.1
+LINK_VALIDATOR_SERVER_PORT=8000
+```
+
+## Build
+
+```Shell
+docker build -t link-validator:latest .
+```
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](https://gitea.rknet.org/docker/link-validator/src/branch/master/LICENSE) file for details.