Valentin V. Bartenev 3 hónapja
szülő
commit
dedffa6dc2
1 módosított fájl, 22 hozzáadás és 10 törlés
  1. 22 10
      README.md

+ 22 - 10
README.md

@@ -43,9 +43,21 @@
 - светлая и тёмная темы
 - возможность отключения командой `set web off`
 
-Для входа в адресной строке браузера введите `https://ip-адрес-репитера` и согласитесь с предупреждением принять самоподписной SSL-сертификат.  Узнать IP-адрес можно на экране устройства или панели управления вашего роутера.
+Подробнее в документации: [Использование веб-панели ретранслятора](https://vbart.github.io/MeshCoreTel-firmware/web-panel/)
 
-Рекомендуется для начальной настройки и периодической диагностики. На развернутых MQTT-ретрансляторах отключайте панель после завершения настройки, если требуется максимальный запас памяти для MQTT.
+### Веб-API по HTTPS
+
+На устройствах с поддержкой веб-панели также возможно использование встроенного API по Wi-Fi.
+
+Возможности:
+
+ - авторизация по паролю администратора с получением временного токена
+ - выполнение любых CLI-команд для управления, настройки и статуса
+ - получение всей доступной телеметрии
+
+Данный API может быть использован для мониторинга с хранением долгосрочной истории (например с использованием таких инструментов как Prometheus и Grafana), а также автонастройки и управления устройством с помощью скриптов.
+
+Подробнее в документации: [Использование веб-API ретранслятора](https://vbart.github.io/MeshCoreTel-firmware/api/)
 
 ## Релизы
 
@@ -57,14 +69,14 @@
 
 - <https://meshcoretel.ru/ru/flasher>  (под заголовком _Прошивки наблюдателя от VBart_)
 
-## Документация (TODO: перевод и адаптация)
-
-Опубликованный сайт документации:
+## Документация
 
 - <https://vbart.github.io/MeshCoreTel-firmware/>
 
-Текущие страницы документации на GitHub:
-- [Home](./docs/index.md)
-- [Download and Flash Releases](./docs/releases.md)
-- [Build Locally With uv](./docs/local-builds.md)
-- [Custom CLI Commands](./docs/custom-cli.md)
+Основные разделы пользовательского руководства:
+
+- [Сравнение устройств](https://vbart.github.io/MeshCoreTel-firmware/boards/)
+- [Загрузка и прошивка релизов](https://vbart.github.io/MeshCoreTel-firmware/releases/)
+- [Использование веб-панели ретранслятора](https://vbart.github.io/MeshCoreTel-firmware/web-panel/)
+- [Использование веб-API ретранслятора](https://vbart.github.io/MeshCoreTel-firmware/api/)
+- [Пользовательские команды CLI](https://vbart.github.io/MeshCoreTel-firmware/custom-cli/)