From 3be71f0cc464f18e650930db99794f12e76e68ae Mon Sep 17 00:00:00 2001
From: itsscb <dev@itsscb.de>
Date: Thu, 4 Aug 2022 13:40:21 +0200
Subject: [PATCH] Initial README.md

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

diff --git a/README.md b/README.md
index f071317..0aef062 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,24 @@
 # autoprint
 Downloads E-Mails from a specific folder and sends them to the Default Printer via CUPS (lp)
+
+## Requirements
+- *OS*: Any Linux should do
+- *Software*:
+	- CUPS
+	- wkhtmltopdf
+- *Hardware*:
+	- Any Linux compatible Printer should do
+
+## Setup
+- Clone this Repository: ```git clone https://github.com/itsscb/autoprint.git```
+- Build the binary: ```go build```
+- Create the *settings.yaml*-file
+	- Example ```IMAPUri:  imap.provider.com:993
+Username: user@example.com
+Password: P@$$w0Rd
+TLS: true # TLS = true, STARTTLS = false
+SourceFolder: INBOX/Print # Where to get the E-Mails
+DestinationFolder:  INBOX/Printed # Where to move the E-Mails afterwards
+Debug: 0 # 1 = Verbose, 2 = Debug```
+- Run the binary
+	- Optinal using *cron*