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

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

diff --git a/README.md b/README.md
index 1108891..3fd3384 100644
--- a/README.md
+++ b/README.md
@@ -20,12 +20,28 @@ go install \
 
 https://github.com/bufbuild/buf?tab=readme-ov-file
 
+### Proto Dateien anpassen
+
+Die *.proto Dateien, die die verwendeten GRPC Apis des Proxys definieren müssen aus den entsprechenden Projekten
+in das Verzeichnis api/proto kopiert werden.
+
+Die Projekte sind:
+
+* [InfoManager](https://git.ozg-sh.de/ozgcloud-app/info-manager/src/branch/master/info-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.info";``` hinzugefügt werden, damit
+die erzeugten Quellcode-Dateien im selben go package liegen.
+
 ### Protobuf-Code generieren
 
 ```
 buf generate
 ```
 
+Erzeugt dann den Code für das Gateway und auch die Datei gen/openapiv2/infomanager.swagger.json.
+Diese Datei kann dann in anderen Projekten verwendet werden um die nötige DTO Klassen zu erzeugen.
+
 ### Anwendung starten
 
 ```
-- 
GitLab