Documentation for building an image with the new GH Action

* update readme and comments

.github/workflows/build.yaml

@@ -2,7 +2,7 @@ name: Build and publish image
 
 on:
   push:
-      branches:
+    branches:
       - main
   workflow_dispatch:
 
@@ -26,12 +26,13 @@ jobs:
             ${{ runner.os }}-
 
       - uses: nelonoel/[email protected]
-      
+
       - name: Set outputs
         id: vars
         run: echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
 
-#build the image and push it to the registry
+
+      #build the image and push it to the registry
       - uses: mr-smithers-excellent/docker-build-push@v5
         name: push-container-image
         with:
@@ -41,4 +42,5 @@ jobs:
           buildArgs: BRANCH=${BRANCH_NAME},COMMIT=${{ steps.vars.outputs.sha_short }},VERSION=${{ steps.vars.outputs.sha_short }}
           username: ${{ github.repository }}
           password: ${{ secrets.GITHUB_TOKEN }}
+          # if the branch is main, add the latest tag
           addLatest: ${{ github.ref == 'refs/heads/main' }}

README.md

@@ -25,3 +25,11 @@ Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protrac
 ## Further help
 
 To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
+
+
+## Building an Image for Deployment
+
+Use the GitHub Action "Build and publish image" to build an image of a selected branch and release it as a package in this repository.
+The naming convention for the image is [branch]-[commit-hash]
+
+The action is also triggered automatically when a commit to main occurs.