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/)