From 911450c72e83985a8ff8a7f1301184515f4aa351 Mon Sep 17 00:00:00 2001
From: nico <nico@magicbroccoli.de>
Date: Thu, 30 May 2019 02:49:38 +0200
Subject: readme config.py addition

* update README to explain config.py
---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index b11279a..97c056f 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,19 @@ modules:
     ...
 ```
 
+### config.json
+The `config.json` file is used to preserve date from possible updates to this script. `config.py` will load `config
+.json` to extract the name, which is used to sign the report message with. In the future there might be other things 
+the `config.json` may contain.
+
+```json
+$ cat config.json
+{
+  "name": "username"
+}
+```
+
+
 ## usage main.py
 ```
 usage: main.py [-h] [-in INFILE [INFILE ...]] [-d DOMAIN] [-r]
-- 
cgit v1.2.3-18-g5258