Update documentation

README.md

@@ -7,16 +7,59 @@ Helm's [documentation](https://helm.sh/docs) to get started.
 
 Once Helm has been set up correctly, add the repo as follows:
 
+```
     helm repo add flyimg https://charts.flyimg.io
-
+```
 If you had already added this repo earlier, run `helm repo update` to retrieve
 the latest versions of the packages.  You can then run `helm search repo
 flyimg` to see the charts.
 
 To install the flyimg chart:
 
+```
     helm install my-flyimg flyimg/flyimg
+```
+
+### Customizing Installation
+
+You can customize your Flyimg installation by providing a custom values.yaml file. For example:
+
+```
+    helm install <release_name> flyimg/flyimg -f values.yaml
+```
+
+Alternatively, you can pass in parameters directly via the command line:
+
+```
+    helm install <release_name> flyimg/flyimg \
+        --set key1=value1,key2=value2
+```
+
+To override the default configuration for Flyimg, you can do that by adding the needed changes in the `parameters:` section in your values.yaml file as the following example:
+
+```yaml
+parameters:
+    storage_system: local
+    aws_s3:
+        access_id: 'xxxxxxx'
+        secret_key: 'xxxxxx'
+        region: 'eu-central-1'
+        bucket_name: 'xxxxx'
+    ....
+```
+
+## Upgrade Flyimg
+
+To upgrade the Flyimg chart after making changes to your configuration:
+
+```
+    helm upgrade flyimg/flyimg
+```
+
+## Uninstalling Flyimg
 
 To uninstall the chart:
 
+```
     helm delete my-flyimg
+```

charts/flyimg/Chart.yaml

@@ -1,27 +1,20 @@
 apiVersion: v2
 name: flyimg
 description: A Helm chart for Kubernetes for Flyimg app
+type: application
 maintainers:
   - name: sadok-f
     email: [email protected]
     url: https://github.com/sadok-f
 
-# A chart can be either an 'application' or a 'library' chart.
-#
-# Application charts are a collection of templates that can be packaged into versioned archives
-# to be deployed.
-#
-# Library charts provide useful utilities or functions for the chart developer. They're included as
-# a dependency of application charts to inject those utilities and functions into the rendering
-# pipeline. Library charts do not define any templates and therefore cannot be deployed.
-type: application
+keywords:
+  - flyimg
+  - image-resizing
+  - image-optimization
+  - avif
+  - mozjpeg
+  - webp
 
-# This is the chart version. This version number should be incremented each time you make changes
-# to the chart and its templates, including the app version.
-# Versions are expected to follow Semantic Versioning (https://semver.org/)
 version: 0.2.1
 
-# This is the version number of the application being deployed. This version number should be
-# incremented each time you make changes to the application. Versions are not expected to
-# follow Semantic Versioning. They should reflect the version the application is using.
 appVersion: 1.4.12