From 6cabebefede1006ca597241e5f45477f9accaa74 Mon Sep 17 00:00:00 2001
From: sw1tchbl4d3 <sw1tchbl4d3@sw1tchbl4d3.com>
Date: Fri, 16 Jul 2021 00:43:18 +0200
Subject: [PATCH] Add some explanations for the config to the README

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

diff --git a/README.md b/README.md
index c5d5d77..ae0243b 100644
--- a/README.md
+++ b/README.md
@@ -31,5 +31,16 @@ sudo make uninstall
 rdo [command]
 ```
 
+The configuration file has the following variables:
+```
+username=sw1tchbl4d3
+wrong_pw_sleep=1000
+session_ttl=5
+```
+
+- `username`: The username of the user that is allowed to execute rdo (no multi user or group support (yet)).
+- `wrong_pw_sleep`: The amount of milliseconds to sleep at a wrong password attempt. Must be a positive integer. Set to 0 to disable.
+- `session_ttl`: The amount of minutes a session lasts. Must be a positive integer. Set to 0 to disable.
+
 ### Dependencies
 - `libbsd`