doc: Update README

.github/workflows/chart.yaml

@@ -1,4 +1,4 @@
-name: Release Charts
+name: Release Helm Chart
 
 on:
   push:
@@ -11,21 +11,19 @@ jobs:
       contents: write
     runs-on: ubuntu-latest
     steps:
-      -
-        name: Checkout
+      - name: Checkout
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      - 
-        name: Configure Git
+      - name: Configure Git
         run: |
           git config user.name "$GITHUB_ACTOR"
           git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
-      - 
-        name: Install Helm
+      - name: Install Helm
         uses: azure/setup-helm@v3
-      - 
-        name: Run chart-releaser
+      - name: Run chart-releaser
         uses: helm/chart-releaser-action@v1.6.0
+        with:
+          pages_branch: charts-registry
         env:
           CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/docker.yaml

@@ -1,46 +1,26 @@
-name: ci
+name: Release Docker Image
 
 on:
   push:
     branches:
-      - 'master'
-    tags:
-      - 'v*'
-  pull_request:
-    branches:
-      - 'master'
+      - "main"
 
 jobs:
   docker:
     runs-on: ubuntu-latest
     steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v4
-      -
-        name: Docker meta
-        id: meta
-        uses: docker/metadata-action@v5
-        with:
-          images: |
-            gdurandvadas/air-helm
-          tags: |
-            type=ref,event=branch
-            type=ref,event=pr
-            type=semver,pattern={{version}}
-            type=semver,pattern={{major}}.{{minor}}
-      -
-        name: Login to DockerHub
-        if: github.event_name != 'pull_request'
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Login to Docker Hub
         uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
-      -
-        name: Build and push
+      - name: Build and push
         uses: docker/build-push-action@v5
         with:
-          context: .
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: gdurandvadas/air-helm:latest

README.md

@@ -1,5 +1,84 @@
 # Air Helm
 
+[![Docker Image Version](https://img.shields.io/docker/v/gdurandvadas/air-helm?arch=arm64&logo=docker&logoColor=white&label=Docker%20Hub&labelColor=%231D63ED&color=%23E5F2FC)](https://hub.docker.com/r/gdurandvadas/air-helm/tags)
+[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/air-helm)](https://artifacthub.io/packages/search?repo=air-helm)
+
+## Introduction
+
 Welcome to Air Helm, a tool crafted to support the development of Go applications within Kubernetes environments.
 
-Modern API servers often require a complex assembly of infrastructure components, and Air Helm is designed to navigate this complexity from your local setup. By integrating Air for live reloading with a Helm chart for local Kubernetes deployment, Air Helm accelerates the development experience. This synergy enables developers to work on their Go applications and accurately define and interact with the necessary architecture components. 
+Modern API servers often require a complex assembly of infrastructure components, and Air Helm is designed to navigate this complexity from your local setup. Air Helm integrates [Air](https://github.com/cosmtrek/air) for live reloading and [Helm](https://helm.sh) for managing Kubernetes applications, facilitating the development and testing of Go applications in a local Kubernetes environment. This synergy enables developers to work on their Go applications and accurately define and interact with the necessary architecture components.
+
+## Key Features
+
+- **Live Reloading**: Instant code reloads in Kubernetes without restarting pods.
+- **Local Development Ease**: Helm chart simplifies deployment and management.
+- **Architecture Integration**: Develop in a local environment as it was production.
+
+## How It Works
+
+Air Helm works by mounting your local Go project directory into a Kubernetes pod. This allows Air to monitor changes to the files and trigger rebuilds and restarts automatically. Here's what happens under the hood:
+
+- **Local Directory Mounting**: Your local project directory is mounted into the Kubernetes pod, allowing the container to access your Go code in real time.
+- **Hot reloading**: Air watches for file changes in your project and triggers builds and restarts as needed, ensuring that the latest changes are always running.
+- **Helm for Kubernetes**: Helm manages the deployment of these settings into your local Kubernetes, configuring things like service exposure, persistent volumes, and more.
+
+## Getting Started
+
+### Prerequisites
+
+- Docker
+- Kubernetes cluster (e.g., Minikube or Docker Desktop's Kubernetes)
+- Helm 3.x
+
+### Installation
+
+Add the Air Helm repository and install the Helm chart:
+
+```bash
+helm repo add gdurandvadas https://gdurandvadas.github.io/air-helm/
+helm repo update
+helm install my-local-env gdurandvadas/air-helm
+```
+
+### Configuration
+
+Here's how you can configure the Air Helm chart in your `helmfile.yaml`:
+
+```yaml
+repositories:
+  - name: gdurandvadas
+    url: https://gdurandvadas.github.io/air-helm/
+
+releases:
+- name: api
+  namespace: backend
+  chart: gdurandvadas/air-helm
+  values:
+    - airServer:
+        code:
+          directory: "/Users/{username}/project" # Root directory of your project
+          modulePath: "example/api" # Module path relative to the project root
+          buildSource: "./cmd/server" # Path to the entry point of the application
+    - service:
+        type: LoadBalancer # Expose the service on a public IP
+        http:
+          enabled: true
+          port: 8080
+    - image:
+        tag: commit # Docker image tag to use
+```
+
+You can see a full API example in the [example](./example/api/) directory
+
+### Accessing Your Application
+
+Depending on your service configuration, you can access your application typically via a local URL or an IP exposed by Kubernetes.
+
+## Advanced Configuration
+
+Review the `values.yaml` file for detailed options like autoscaling, ingress settings, and more. Tailor these settings to fit the needs of your development and production environments.
+
+## License
+
+Air Helm is open-sourced under the Apache License 2.0. For more details, see the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)