From 69eb3d4cc78d354221450df43d5fe0b831e04bd1 Mon Sep 17 00:00:00 2001
From: Ridham Patel <127187827+ridh21@users.noreply.github.com>
Date: Sun, 13 Oct 2024 15:13:44 +0530
Subject: [PATCH] Update README.md

Updated Readme Changes, made it more user friendly
---
 README.md | 62 ++++++++++++++++++++++++++++---------------------------
 1 file changed, 32 insertions(+), 30 deletions(-)

diff --git a/README.md b/README.md
index 35303c0b..d409ff13 100644
--- a/README.md
+++ b/README.md
@@ -1,37 +1,39 @@
-# Introduction
+# Mastodon Helm Chart
 
-This is a [Helm](https://helm.sh/) chart for installing Mastodon into a
-Kubernetes cluster.  The basic usage is:
+## Introduction
 
-1. edit `values.yaml` or create a separate yaml file for custom values
-1. `helm dep install`
-1. `helm install --namespace mastodon --create-namespace my-mastodon ./ -f path/to/additional/values.yaml`
+This [Helm](https://helm.sh/) chart facilitates the installation of Mastodon on a Kubernetes cluster. It has been tested with Kubernetes 1.21+ and Helm 3.8.0+.
 
-This chart is tested with k8s 1.21+ and helm 3.8.0+.
+## Quick Start
 
-# NOTICE: Future Deprecation
+1. Modify `values.yaml` or create a separate YAML file for custom values.
+2. Run `helm dep install`.
+3. Install the chart:
+   ```
+   helm install --namespace mastodon --create-namespace my-mastodon ./ -f path/to/additional/values.yaml
+   ```
 
-We have plans in the very near future to deprecate this chart in favor of a [new git repo](https://github.com/mastodon/helm-charts), which has proper helm repository support (e.g. `helm repo add`), and will contain multiple charts, both for mastodon and for supplementary components that we make use of.
+## Important Notice: Future Deprecation
 
-We still encourage suggestions and PRs to help make this chart better, and this repository will remain available after the new charts are ready to give users time to migrate. However, we will not be approving large PRs, or PRs that change fundamental chart functions, as those changes should be directed to the new charts.
+We are planning to deprecate this chart in favor of a [new GitHub repository](https://github.com/mastodon/helm-charts). The new repository will offer proper Helm repository support (e.g., `helm repo add`) and will contain multiple charts for Mastodon and its supplementary components.
 
-Please see the pinned [GitHub issue](https://github.com/mastodon/chart/issues/129) for more info & discussion.
+While we continue to welcome suggestions and PRs to improve this chart, we will not be approving large PRs or changes to fundamental chart functions. These changes should be directed to the new charts.
 
-# Configuration
+For more information and discussion, please refer to the pinned [GitHub issue](https://github.com/mastodon/chart/issues/129).
 
-The variables that _must_ be configured are:
+## Configuration
 
-- password and keys in the `mastodon.secrets`, `postgresql`, and `redis` groups; if
-  left blank, some of those values will be autogenerated, but will not persist
-  across upgrades.
+### Required Configuration
 
+- Passwords and keys in the `mastodon.secrets`, `postgresql`, and `redis` groups. If left blank, some values will be auto-generated but won't persist across upgrades.
 - SMTP settings for your mailer in the `mastodon.smtp` group.
 
-If your PersistentVolumeClaim is `ReadWriteOnce` and you're unable to use a S3-compatible service or
-run a self-hosted compatible service like [Minio](https://min.io/docs/minio/kubernetes/upstream/index.html)
-then you need to set the pod affinity so the web and sidekiq pods are scheduled to the same node.
+### Pod Affinity Configuration
+
+If your PersistentVolumeClaim is `ReadWriteOnce` and you're unable to use an S3-compatible service or run a self-hosted compatible service like [Minio](https://min.io/docs/minio/kubernetes/upstream/index.html), you need to set pod affinity to ensure web and sidekiq pods are scheduled on the same node.
 
 Example configuration:
+
 ```yaml
 podAffinity:
   requiredDuringSchedulingIgnoredDuringExecution:
@@ -44,9 +46,9 @@ podAffinity:
       topologyKey: kubernetes.io/hostname
 ```
 
-# Administration
+## Administration
 
-You can run [admin CLI](https://docs.joinmastodon.org/admin/tootctl/) commands in the web deployment.
+You can run [admin CLI](https://docs.joinmastodon.org/admin/tootctl/) commands in the web deployment:
 
 ```bash
 kubectl -n mastodon exec -it deployment/mastodon-web -- bash
@@ -54,21 +56,21 @@ tootctl accounts modify admin --reset-password
 ```
 
 or
+
 ```bash
 kubectl -n mastodon exec -it deployment/mastodon-web -- tootctl accounts modify admin --reset-password
 ```
 
-# Missing features
-
-Currently this chart does _not_ support:
+## Current Limitations
 
+This chart does not currently support:
 - Hidden services
 - Swift
 
-# Upgrading
+## Upgrading
+
+Due to the separation of database migrations as a Job from the Rails and Sidekiq deployments, they may occasionally occur in the wrong order. After upgrading Mastodon versions, it might be necessary to manually delete the Rails and Sidekiq pods so they are recreated with the latest migration.
+
+## Support
 
-Because database migrations are managed as a Job separate from the Rails and
-Sidekiq deployments, it’s possible they will occur in the wrong order.  After
-upgrading Mastodon versions, it may sometimes be necessary to manually delete
-the Rails and Sidekiq pods so that they are recreated against the latest
-migration.
+For questions, issues, or contributions, please open an issue or pull request in our GitHub repository.