From 29e31f90a67b45439dc099ee686ed83567c12064 Mon Sep 17 00:00:00 2001
From: justuser <justuser@noreply.localhost>
Date: Sat, 9 Mar 2024 15:34:50 +0300
Subject: [PATCH] Update 'README.md'

---
 README.md | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 44d4210..5f70d21 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,25 @@
-Just ping server and get stats.
+## Что это?
+
+Это проект, который предоставялет: простого онлайн ТГ бота ; аналитику сервера по типу пинг сервера, количество игроков.
+
+<img src="https://gitea.404.mn/justuser/minestatsping/raw/branch/main/preview/2024-03-09_12-20.png" alt="drawing" width="400"/>
+
+## Как использовать?
+
+### Использование ТГ бота
+
+1. Получить токен в https://t.me/BotFather
+2. Запустить: `python online.py`
+3. Вставить токен в `config.json`, где написано "token"
+4. Запустить: `python online.py`
+5. Проверить команду бота: `/online`
+
+### Использование аналитики
+
+1. Указать данные сервера в `ping.py`
+    - адрес - host
+    - порт - port
+    - протокол - prot ( https://minecraft.fandom.com/wiki/Protocol_version#Java_Edition )
+2. Запустить сбор статистики: `python ping.py`
+3. Запустить сайт: `python site_stat.py`
+4. Зайти на сайт: `127.0.0.1:8050` (браузер)
\ No newline at end of file