From dedffa6dc2eef5e6d24ad778dfcedec0d94200c9 Mon Sep 17 00:00:00 2001 From: "Valentin V. Bartenev" Date: Sat, 2 May 2026 20:08:45 +0300 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++++++++++++++---------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 52df5b8b..e5fd70b1 100644 --- a/README.md +++ b/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 @@ - (под заголовком _Прошивки наблюдателя от VBart_) -## Документация (TODO: перевод и адаптация) - -Опубликованный сайт документации: +## Документация - -Текущие страницы документации на 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/)