Merge pull request #22 from inspectIT/updateReadme

added a description of bulding the docker image for local use and how… (#22)

Co-Authored-By: Dimi-Ma <dimi.mÂ@gmx.de>

Author: Dimi-Ma

.github/workflows/eumserver_release.yml

@@ -67,7 +67,7 @@ jobs:
         - name: Check if jar exists and rename it
           run: |
             cd docker
-            mv inspectit-ocelot-eum-server-${{ github.ref_name }}.jar inspectit-ocelot-eum-server.jar
+            mv inspectit-ocelot-eum-server-:${{ github.ref_name }}.jar inspectit-ocelot-eum-server.jar
             ls
         - name: Set up QEMU
           uses: docker/setup-qemu-action@v2

README.md

@@ -279,3 +279,12 @@ INSPECTIT_EUM_SERVER_SECURITY_AUTH_PROVIDER_SIMPLE_TOKEN_DIRECTORY=<my-directory
 INSPECTIT_EUM_SERVER_SECURITY_AUTH_PROVIDER_SIMPLE_ENABLED=TRUE;
 INSPECTIT_EUM_SERVER_SECURITY_ENABLED=TRUE
 ```
+
+##### Build Docker Image Locally.
+
+In order to build a docker image locally, the eum-server should be build locally and the resulting jar should be renamed
+to ```inspectit-ocelot-eum-server.jar``` and copied to the ./docker directory
+
+##### How to Release
+To create a new release, you have to create a new git tag and push it on to GitHub. 
+This Tag is the new version number of the release. Afterwards the release build will be automatically triggered.