From 3fd1cd31f8b2b4142b5316504702db5f71444dbc Mon Sep 17 00:00:00 2001
From: STAM <stam@epicm.org>
Date: Sat, 2 Nov 2024 19:57:07 +0300
Subject: [PATCH] Added changelog + Automatic sync with Gitlab's read-only
 mirror

README.md by @wopox1337
---
 .github/workflows/sync-with-gitlab.yml | 31 ++++++++++++++++++++++++++
 CHANGELOG.md                           | 21 +++++++++++++++++
 README.md                              | 22 ++++++++++++++++--
 3 files changed, 72 insertions(+), 2 deletions(-)
 create mode 100644 .github/workflows/sync-with-gitlab.yml
 create mode 100644 CHANGELOG.md

diff --git a/.github/workflows/sync-with-gitlab.yml b/.github/workflows/sync-with-gitlab.yml
new file mode 100644
index 0000000..ac90586
--- /dev/null
+++ b/.github/workflows/sync-with-gitlab.yml
@@ -0,0 +1,31 @@
+name: Automatic sync with Gitlab's read-only mirror
+
+on: [workflow_dispatch, push]
+
+jobs:
+  mirror:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up SSH key for Runner
+        env:
+          SSH_KEY: ${{ secrets.GITLAB_DEPLOY_KEY }}
+        run: |
+          mkdir -p ~/.ssh
+          echo "$SSH_KEY" > ~/.ssh/id_ed25519
+          chmod 600 ~/.ssh/id_ed25519
+          ssh-keyscan -t rsa github.com >> ~/.ssh/known_hosts
+          ssh-keyscan -t rsa gitlab.com >> ~/.ssh/known_hosts
+
+      - name: Clone repository from GitHub as mirror and push to Gitlab
+        env:
+          REPO_ORIGINAL: "https://github.com/rehlds/relocalizebugfix.git"
+          REPO_TARGET:   "git@gitlab.com:rehlds/relocalizebugfix.git"
+        run: |
+          git clone --mirror "$REPO_ORIGINAL" repo-mirror
+          cd repo-mirror
+          git remote set-url origin "$REPO_TARGET"
+          git push --mirror --force
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..6ad3ab0
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,21 @@
+# [reLocalizeBugFix](https://github.com/rehlds/relocalizebugfix) Changelog
+
+> [!WARNING]
+> This project is now outdated and incompatible with modern ReHLDS versions.
+
+ReLocalizeBug Fix was created to resolve localization issues in Half-Life dedicated servers.
+However, with the updates and advancements in the ReHLDS engine, this plugin is now deprecated and not compatible with current ReHLDS builds.
+
+Initially developed as an extension of [LocalizeBugFix by s1lentq](https://github.com/s1lentq/localizebugfix) for HLDS, it aimed to fix localization-related bugs in the server environment but is no longer maintained.
+
+> [!IMPORTANT]  
+> This project has been [deprecated since 2017](https://github.com/rehlds/rehlds/issues/328#issuecomment-275837883).
+
+---
+ 
+## [`v2.8`](https://github.com/rehlds/relocalizebugfix/releases/tag/v2.8) - 2016-11-03
+
+### Added
+- Public release compatible with ReHLDS
+
+**Full Changelog**: [v1.0](https://github.com/rehlds/hitboxtracker/commits/v2.8)
diff --git a/README.md b/README.md
index 360d4eb..f7ccd39 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,21 @@
-#ReLocalizeBug Fix
+## [reLocalizeBugFix](https://github.com/rehlds/relocalizebugfix) [![Percentage of issues still open](http://isitmaintained.com/badge/open/rehlds/relocalizebugfix.svg)](http://isitmaintained.com/project/rehlds/relocalizebugfix "Percentage of issues still open") [![GitHub license](https://img.shields.io/github/license/rehlds/relocalizebugfix.svg?longCache=true&style=flat-square)](https://github.com/rehlds/relocalizebugfix/blob/master/LICENSE.md) [![Deprecated](https://img.shields.io/badge/status-Deprecated-red.svg?style=flat-square)](https://github.com/rehlds/relocalizebugfix/) [![GitHub issues](https://img.shields.io/github/issues/rehlds/relocalizebugfix.svg?longCache=true&style=flat-square)](https://github.com/rehlds/relocalizebugfix/issues) [![GitHub forks](https://img.shields.io/github/forks/rehlds/relocalizebugfix.svg?longCache=true&style=flat-square)](https://github.com/rehlds/relocalizebugfix/network) [![GitHub stars](https://img.shields.io/github/stars/rehlds/relocalizebugfix.svg?longCache=true&style=flat-square)](https://github.com/rehlds/relocalizebugfix/stargazers)
 
-Fix exploit localization strings in chat
+> [!WARNING]
+> This project is now outdated and incompatible with modern ReHLDS versions.
+
+### Installation
+To install the ReLocalizeBug Fix, add the following lines to your `addons/metamod/plugins.ini` file:
+
+```ini
+win32 addons\relocalizebugfix\relocalizebugfix_mm.dll
+linux addons/relocalizebugfix/relocalizebugfix_mm_i386.so
+```
+
+### Overview
+ReLocalizeBug Fix was created to resolve localization issues in Half-Life dedicated servers. However, with the updates and advancements in the ReHLDS engine, this plugin is now deprecated and not compatible with current ReHLDS builds. Initially developed as an extension of [LocalizeBugFix by s1lentq](https://github.com/s1lentq/localizebugfix) for HLDS, it aimed to fix localization-related bugs in the server environment but is no longer maintained.
+
+> [!IMPORTANT]  
+> This project has been [deprecated since 2017](https://github.com/rehlds/rehlds/issues/328#issuecomment-275837883).
+
+### Warning
+Using this plugin with newer versions of ReHLDS may lead to instability and unexpected behavior. We recommend utilizing supported plugins and features available in the latest releases.