From 9049763e36644a3da3722032f51f4400985d531c Mon Sep 17 00:00:00 2001
From: david-loe <56305409+david-loe@users.noreply.github.com>
Date: Tue, 22 Oct 2024 11:43:30 +0200
Subject: [PATCH] update readme

---
 README.md | 44 ++++++++++++++++++++++++++------------------
 1 file changed, 26 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index b0f7936..b34022e 100644
--- a/README.md
+++ b/README.md
@@ -2,23 +2,29 @@
 
 Syncronisation zwischen Frappe und Optigem / GDI Lohn & Gehalt
 
-## Setup
+## Run
 
-### 1. Pakete installieren
+using docker
 
 ```
-pip install -r requirements.txt
+docker run -v ./config.yaml:/config.yaml davidloe/frappe-optigem-gdi-sync --config /config.yaml
 ```
 
-### 2. pyodbc MSSQL Treiber installieren
-
-https://github.com/mkleehammer/pyodbc/wiki/Install
+or running locally
 
-### 3. Firebird Client Library installieren
+```
+script.py
+```
 
-https://firebirdsql.org/file/documentation/reference_manuals/driver_manuals/odbc/html/fbodbc205-install.html
+```
+options:
+  -h, --help           show this help message and exit
+  --loglevel LOGLEVEL  Setzt das Loglevel (DEBUG, INFO, WARNING, ERROR, CRITICAL)
+  --config CONFIG      Pfad zur Konfigurationsdatei
+  --dry-run            Führt den Sync im Dry-Run-Modus aus (keine Änderungen werden vorgenommen)
+```
 
-### 4. Config anpassen
+## Config anpassen
 
 ```
 cp config.yaml.example config.yaml
@@ -46,16 +52,18 @@ cp config.yaml.example config.yaml
   - Optional: `key_fields` (für Updates)
   - Optional: `create_new` (wenn `true` werden neue Dokumente in der Datenbank eingefügt, für die kein match anhand der `key_fields` gefunden wurde)
 
-## Run
+## Setup Local
 
-```
-python sync.py
-```
+### 1. pyodbc MSSQL Treiber installieren
+
+https://github.com/mkleehammer/pyodbc/wiki/Install
+
+### 2. Firebird Client Library installieren
+
+https://firebirdsql.org/file/documentation/reference_manuals/driver_manuals/odbc/html/fbodbc205-install.html
+
+### 3. Pakete installieren
 
 ```
-options:
-  -h, --help           show this help message and exit
-  --loglevel LOGLEVEL  Setzt das Loglevel (DEBUG, INFO, WARNING, ERROR, CRITICAL)
-  --config CONFIG      Pfad zur Konfigurationsdatei
-  --dry-run            Führt den Sync im Dry-Run-Modus aus (keine Änderungen werden vorgenommen)
+pip install -r requirements.txt
 ```