Update README.md

README.md

@@ -1 +1,18 @@
-# XenforoBot
+## XenforoBot
+Пример Discord бота, выдающего пользователям соответсвующие их аккаунту на форуме Xenforo роли. Авторизация и получение информации о пользователе происходит за счет запросов к Xenforo API (тестирование проводилось на версии 2.2). Работа самого Discord бота осуществлена благодаря библиотеке Discord.NET.
+<br>Бот предлагает пользователю пройти авторизацию в лс при написании команды `!auth` или заходе участника на сервер.</br>
+<br>Если желаете использовать готовое решение от меня, то в файле settings.json (он будет создан сразу после первого запуска программы) необходимо указать все настройки в следующем формате:</br>
+```csharp
+{
+    dsToken: "Токен бота Discord",
+    xfToken: "API токен вашего форума на Xenforo",
+    groupsHierarchy: [1, 2, 3, 4, 5], // Приоритет ID групп на форуме в порядке возрастания
+    groups: [
+        {
+            groupId: 1, // ID группы на форуме
+            dsRoleId: 1234445 // ID роли Discord
+        },
+        // и т.д., пока все группы не будут инициализированы в любом порядке
+    ]
+}
+```