Additional licensing information and more indepth readme

Author: HmSebastianH

README.md

@@ -1,19 +1,47 @@
 
-## Imap Extractor
+# Imap Extractor
 
 This is a very basic tool to scan an email-inbox for certain content.
 
-The parameters are passed through a configuration file in json format, an example can be seen in "example-config.json".
+The parameters are passed through a configuration file in json format, an example can be seen in below.
 The path to said configuration shall be passed as first parameter of the program.
 
+Disclaimer: This tool was just a quick implementation for our CI needs, which might also be useful for others.
+
+
+##Usage:
+To call the program use:
+```
+imap-extractor <path to config json>
+```
+
+For detailed description of config json see below. Configured regex needs to contain at least one group.
+Result will be content of group of first match found in the email inbox.
+Additional unnamed groups may be used inside the regex.
+
+##Parameters:
+
 The following configurations are to be included in the configuration:
 * imap-host: Url on which the email host can be reached
-* imap-port: Port on which the IMAP protocol is offered
+* imap-port: Port on which the IMAP protocol is offered (Usually 143 or 993)
 * username: Login username for email host
 * password: Password for above username
 * from-filter: Name filter for email origin
 * regexp: Regex for which the emails will be scanned, including a group for the result
 
 
 On execution this program will go through the inbox of given email address from newest to oldest.
-Once any match with the given regex is found, the content of the first capturing group in the regex will be returned. 
+Once any match with the given regex is found, the content of the first capturing group in the regex will be returned. 
+
+
+##Config Example:
+```json
+{
+  "imap-host": "mobiuscode.de/",
+  "imap-port": 993,
+  "username": "user@mobiuscode.de",
+  "password": "tryOutPanicMode",
+  "from-filter": "boss@mobiuscode.de",
+  "regexp": "please see important thing below:(?:[\\s]+)([\\S]+)(?:[\\s]+)"
+}
+```

example-config.json

@@ -1,3 +1,17 @@
+// Copyright 2022 MobiusCode GmbH
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package main
 
 import (
@@ -18,17 +32,17 @@ import (
 
 type Config struct {
 	// Host URL on which the emails are received
-	ImapHost      string `json:"imap-host"`
+	ImapHost string `json:"imap-host"`
 	// Port for the IMAP protocol
-	ImapPort      int    `json:"imap-port"`
+	ImapPort int `json:"imap-port"`
 	// Email-User for login
-	EmailUser     string `json:"username"`
+	EmailUser string `json:"username"`
 	// Corresponding password
 	EmailPassword string `json:"password"`
 	// Filter for the "from" email field (Name, not email)
-	FromFilter    string `json:"from-filter"`
+	FromFilter string `json:"from-filter"`
 	// Regex to be scanned for, first matched group is used as a result
-	ContentRegex  string `json:"regexp"`
+	ContentRegex string `json:"regexp"`
 }
 
 func main() {