Merge pull request 'Populated README' (#11) from migration into master

Reviewed-on: #11

.drone.yml

@@ -45,6 +45,8 @@ steps:
       GITEA_USER: { from_secret: git_username }
       GITEA_PASS: { from_secret: git_password }    
     commands:
+      - echo "169.255.58.144 gitea.khongisa.co.za" >> /etc/hosts
+      - apk add --no-cache curl
       - git remote set-url origin https://$${GITEA_USER}:$${GITEA_PASS}@gitea.khongisa.co.za/litecharms/scheduler.git
       - git tag 1.${DRONE_BUILD_NUMBER}
       - git push origin 1.${DRONE_BUILD_NUMBER}
@@ -81,7 +83,6 @@ steps:
       - mkdir -p $HOME/.kube
       - echo "$KUBE_CONFIG" > $HOME/.kube/config
       - kubectl apply -f litecharms-scheduler-uat.yml
-      - kubectl set image statefulset/litecharms-scheduler-uat scheduler=nexus.khongisa.co.za/litecharms-scheduler:1.${DRONE_BUILD_NUMBER} -n litecharms-scheduler-uat
 
 depends_on:
   - package
@@ -104,7 +105,6 @@ steps:
       - echo "$KUBE_CONFIG" > $HOME/.kube/config
       - kubectl apply -f litecharms-scheduler.yml
       - kubectl rollout restart statefulset/litecharms-scheduler -n litecharms-scheduler
-      - kubectl set image statefulset/litecharms-scheduler scheduler=nexus.khongisa.co.za/litecharms-scheduler:1.${DRONE_BUILD_NUMBER} -n litecharms-scheduler
 
 depends_on:
   - uat

README.md

@@ -1 +1,18 @@
-# LiteCharms
+# LiteCharms.Scheduler
+
+The background processing engine responsible for automated tasks and scheduled jobs.
+
+## 🏗 Architecture
+* **Type:** Kubernetes **StatefulSet**
+* **Persistence:** Uses Postgres at `192.168.1.170`.
+* **Clustering:** Configured for Quartz.NET/Hangfire clustering to support multiple replicas without task duplication.
+
+## 🚀 CI/CD Workflow
+* **Trigger:** Pull Request to `master`.
+* **Versioning:** Automated Gitea Releases with links to Docker and NuGet artifacts.
+* **Identity:** Uses stable network identifiers (`litecharms-scheduler-0`, etc.) to maintain lock integrity in the database.
+
+## ⚙️ Scaling
+To scale the scheduler:
+`kubectl scale statefulset litecharms-scheduler --replicas=3`
+*Note: Ensure Database Job Store is enabled in appsettings before scaling.*