From 56e140dc2d0b09f9b11ed562ca6f4e9cc4792729 Mon Sep 17 00:00:00 2001
From: ABKAM2023 <149762275+ABKAM2023@users.noreply.github.com>
Date: Tue, 13 Feb 2024 17:18:50 +0200
Subject: [PATCH] Update README.md

---
 README.md | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b2972f9..7f972ed 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,21 @@
-# cs2-geoip-rankspoints
-[CS2] [RanksPoints] Module - GeoIP
+# RanksPoints Module - GeoIP
+**RanksPoints Module - GeoIP** - это дополнение, предназначенное для интеграции с плагином Ranks Points, а также обеспечивает совместимость с другими плагинами, использующими базу данных от Levels Ranks. Этот модуль занимается сбором данных о местоположении игроков, включая их IP-адреса, страны, регионы и города. Собранная информация доступна исключительно через Веб-Интерфейс.
+
+# Установка
+1. Установите [Metamod:Source](https://www.sourcemm.net/downloads.php/?branch=master) и [CounterStrikeSharp](https://github.com/roflmuffin/CounterStrikeSharp)
+2. Скачайте RanksPoints Module - GeoIP.
+3. Распакуйте архив и загрузите его на игровой сервер.
+4. Запустите сервер, чтобы создать необходимые конфигурационные файлы.
+5. Подключите плагин к базе данных, введя необходимые данные в файл dbconfig.json. Убедитесь в корректности введенных данных.
+
+# Конфиг подключения базы данных (dbconfig.json)
+```
+{
+  "DbHost": "YourHost",
+  "DbUser": "YourUser",
+  "DbPassword": "YourPassword",
+  "DbName": "YourDatabase",
+  "DbPort": "3310",
+  "TableName": "lvl_base"
+}
+```