From efe338b61cab7688bf1cd1fcec20e06cd7546def Mon Sep 17 00:00:00 2001
From: OZGCloud <ozgcloud@mgm-tp.com>
Date: Wed, 27 Nov 2024 11:20:27 +0100
Subject: [PATCH] updated README

---
 README.md | 24 +++++++++++++++++++++---
 1 file changed, 21 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 42b5fb5..d0c8122 100644
--- a/README.md
+++ b/README.md
@@ -33,24 +33,42 @@ go install \
 
 https://github.com/bufbuild/buf?tab=readme-ov-file
 
-### Protobuf-Code generieren
+### Proto Dateien anpassen
+
+Die *.proto Dateien, die die verwendetetn GRPC Apis des Proxys definieren müssen aus den entsprechenden Projekten
+in das Verzeichnis api/proto kopiert werden.
+
+Die Projekte sind:
+
+* [VorgangManager](https://git.ozg-sh.de/ozgcloud-app/vorgang-manager/src/branch/master/vorgang-manager-interface/src/main/protobuf)
+* [NachrichtenManager](https://git.ozg-sh.de/ozgcloud-app/nachrichten-manager/src/branch/master/nachrichten-manager-interface/src/main/protobuf)
+
+Damit die Code generierung funktioniert müssen die proto-Dateien aktuell noch angepasst werden.
+Dazu muss in jede Datei die Zeile ```option go_package = "de.ozgcloud.antragraumproxy";``` hinzugefügt werden, damit
+die erzeugten Quellcode-Dateien im selben go package liegen.
+
+### Protobuf-Code und swagger datei generieren
 
 ```
 buf generate
 ```
 
+Erzeugt dann den Code für das Gateway und auch die Datei gen/openapiv2/openapiv2.swagger.json.
+Diese Datei kann dann in anderen Projekten verwendet werden um die nötige DTO Klassen zu erzeugen.
+
 ### Anwendung starten
 
 ```
 ACTIVE_PROFILE=local go run cmd/antragsraum-proxy/main.go
 ```
 
-## Config 
+## Config
+
 config.yml is the default config for deployment
 
 [Config-Datei](./config/config.yml)
 
-config-local.yml is the config file for local development 
+config-local.yml is the config file for local development
 setting ACTIVE_PROFILE=local will load the config-local.yml
 
 [Config-Datei](./config/config-local.yml)
-- 
GitLab