diff --git a/README.md b/README.md index 6e6b36d..5ed1cba 100644 --- a/README.md +++ b/README.md @@ -4,54 +4,48 @@ ## Возможности -- Отслеживание новых релизов типовых конфигураций - -- Автоматическое уведомления о выходе новых версий - -- Просмотр списка конфигураций из подписки - +- Автоматическое отслеживание новых версий конфигураций +- Уведомления о появлении актуальных версий конфигураций +- Включение и отключение уведомлений о выходе новых версий конфигураций +- Просмотр списка отслеживаемых конфигураций - Добавление конкретной конфигурации в список отслеживания - - Удаление конкретной конфигурации из списка отслеживания - - Просмотр статуса конкретной конфигурации (текущая версия -> актуальная версия) -- Включение/отключение уведомлений о выходе новых версий конфигураций - ## Используемые технологии - 1С:Предприятие 8.3 - -- HTTP-сервисы 1С - +- HTTP-сервисы 1С - Telegram Bot API - -- Хранение данных подписчиков в информационной базе - - Интеграция с официальным сайтом обновлений 1С (releases.1c.ru) +- Проверка качества кода SonarQube +- Сборка проекта Jenkins +- Отчёты Allure ## Установка и настройка Бот не требует внешнего сервера или промежуточного backend-а. Всё реализовано средствами платформы 1С. -- Клонируйте или скачайте репозиторий: - -`git clone https://github.com/your-username/1c-release-checker-bot.git` - - - Загрузите конфигурацию в информационную базу 1С (можно как в режиме тонкого клиента, так и через конфигуратор). - +- Клонируйте или скачайте репозиторий: `git clone https://github.com/K4shey/tg_bot_1c.git` +- Создайте новую информационную базу. В режиме конфигуратора выполните команду загрузки конфигурации из файлов. +- Укажите путь к источнику: `tg_bot_1c\src\cf` - Зарегистрируйте Telegram-бота через @BotFather и получите токен. - - - Укажите токен в настройках бота внутри конфигурации. - - - Запустите HTTP-сервис (веб-сервер 1С или публикация в режиме веб-клиента). +- Укажите токен в настройках конфигурации, раздел Администрирование. +- Есть возможность получать обновления в двух режимах: long polling и webhook. Режим устанавливается в настройках, раздел Администрирование. В случае использования webhook требуется публикация базы на веб-сервере. +- В режиме предприятия выполните начальную инициализацию. Раздел Администрирование - Начальное заполнение данных. ## Поддерживаемые команды -Команда Описание -/start Приветствие и справка -/add Подписка на отслеживание конфигурации по коду -/remove Удаление подписки -/list Просмотр всех текущих подписок -/check Ручная проверка релизов -/help Справка по командам \ No newline at end of file +Команда     Описание + +/start      Приветствие и справка + +/add        Подписка на отслеживание конфигурации по коду + +/remove     Удаление подписки + +/list       Просмотр всех текущих подписок + +/check      Ручная проверка релизов + +/help       Справка по командам \ No newline at end of file