aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authornico <nico@magicbroccoli.de>2019-05-30 02:49:38 +0200
committernico <nico@magicbroccoli.de>2019-05-30 02:49:38 +0200
commit911450c72e83985a8ff8a7f1301184515f4aa351 (patch)
tree294e7128f8e874952278dfee0a156b2cd379ba6b /README.md
parent0d9f4147b08be59e2f6dc98efce24942985a590b (diff)
readme config.py addition
* update README to explain config.py
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
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]