improve README.md and the release.yml workflow

Author: ThoSap

.github/workflows/release.yml

@@ -59,7 +59,8 @@ jobs:
       - name: Push tag to remote
         run: ./gradlew --console=colored pushRelease
         shell: bash
-      - uses: aboutbits/github-actions-base/github-create-release@v2
+      - name: Create GitHub Release
+        uses: aboutbits/github-actions-base/github-create-release@v2
         with:
           tag-name: 'v${{ steps.nextVersion.outputs.version }}'
           release-description: |
@@ -70,6 +71,9 @@ jobs:
             helm install postgresql-operator https://github.com/${{ github.repository }}/releases/download/v${{ steps.nextVersion.outputs.version }}/postgresql-operator-${{ steps.nextVersion.outputs.version }}.tgz
             ```
             
+            With the Helm chart, the Custom Resource Definitions (CRDs) are installed automatically.
+            However, if you deploy the operator directly from the OCI image, the CRDs are not automatically applied and must be installed separately.
+            
             ### Manual CRD Installation
             ```bash
             kubectl apply -f https://github.com/${{ github.repository }}/releases/download/v${{ steps.nextVersion.outputs.version }}/clusterconnections.postgresql.aboutbits.it-v1.yml
@@ -86,3 +90,11 @@ jobs:
         run: |
           gh release upload v${{ steps.nextVersion.outputs.version }} operator/build/helm/kubernetes/*.tgz operator/build/kubernetes/*.postgresql.aboutbits.it-v1.yml
         shell: bash
+      - name: Update README.md
+        run: |
+          sed -i "s|releases/download/v[0-9.]*/postgresql-operator-[0-9.]*.tgz|releases/download/v${{ steps.nextVersion.outputs.version }}/postgresql-operator-${{ steps.nextVersion.outputs.version }}.tgz|g" README.md
+          git add README.md
+          # Guard against failing if there are no changes
+          git diff-index --quiet HEAD || git commit -m "Update README.md with version ${{ steps.nextVersion.outputs.version }}"
+          git push
+        shell: bash

README.md

@@ -31,6 +31,18 @@ AboutBits PostgreSQL Operator is a Kubernetes operator that helps you manage Pos
 └──────────────────────────────────────────────────────────────────────────┘
 ```
 
+## Installation
+
+### Helm Chart
+
+```bash
+helm install postgresql-operator https://github.com/AboutBits/postgresql-operator/releases/download/v0.1.1/postgresql-operator-0.1.1.tgz
+```
+
+With the Helm chart, the Custom Resource Definitions (CRDs) are installed automatically.  
+However, if you deploy the operator directly from the OCI image, the CRDs are not automatically applied and must be installed separately.  
+See the release notes for the [latest version](https://github.com/AboutBits/postgresql-operator/releases/latest) for more information.
+
 ## Usage
 
 This operator allows you to manage PostgreSQL resources using Kubernetes manifests.