From 5032a0d90d4e2f14d4d9636c7d6daeeec6c6becc Mon Sep 17 00:00:00 2001
From: ScarletRedMan <terentev.andrey.2002@gmail.com>
Date: Tue, 19 Aug 2025 23:17:31 +0700
Subject: [PATCH] chore: updated README

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/README.md b/README.md
index de129ca..03ee682 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,34 @@
 msb3
 -----------
+
+## О проекте
+**MinestomServerBase** (msb3) - это надстройка над Minestom, содержащая готовые модули,
+упрощающие разработку мини-игр.
+
+## Использование
+
+Указать репозиторий:
+```groovy
+maven {
+    name = "Gitea"
+    url = uri("https://git.dragonestia.ru/api/packages/Dragonestia/maven")
+
+    credentials(HttpHeaderCredentials) {
+        name = "Authorization"
+        value = "token ${dragonestiaGiteaToken}"
+    }
+
+    authentication {
+        header(HttpHeaderAuthentication)
+    }
+}
+```
+
+Указать зависимость:
+```groovy
+dependencies {
+    implementation 'ru.dragonestia.msb3:msb-api:ВЕРСИЯ'
+}
+```
+
+Последнюю версию можно найти тут: [ТЫК](https://git.dragonestia.ru/Dragonestia/-/packages/maven/ru.dragonestia.msb3:msb-api/)