update README.md

README.md

@@ -1 +1,55 @@
-# autofon-telegram-bot
+# АвтоФон Telegram Бот
+
+Self-hosted Телеграм бот для отслеживания устройств [АвтоФон](http://www.autofon.ru/).
+
+<img src="images/bot_preview.png" width="800px">
+
+## Функции бота
+
+* Отслеживание ваших устойств АвтоФон
+* Отправка уведомление в Телеграм с информацией о новом состоянии
+* Настраиваемый список устройств для отслеживания
+* Формирование графиков на основе истории состояний устройств
+
+## Графики
+
+Температура с датчика устройства
+
+<img src="images/bot_chart_temp.png" width="500px">
+
+Напряжения батареи
+
+<img src="images/bot_chart_volt.png" width="500px">
+
+Затраченное мАч батаерии
+
+<img src="images/bot_chart_consumption.png" width="500px">
+
+## Установка
+
+Для запуска бота необходимо установить [Docker](https://docs.docker.com/get-docker/)
+и [Docker Compose](https://docs.docker.com/compose/install/).
+
+Создать вашего бота и получить токен можно у [@BotFather](https://t.me/BotFather).
+
+Запуск через [docker-compose.yml](/src/main/docker/docker-compose.yml) файл:
+
+https://github.com/Romancha/autofon-telegram-bot/blob/master/src/main/docker/app.yml#L1-L12
+
+В environment переменных указать обязательные
+параметры - ``AUTOFON_TELEGRAM_TOKEN``, ``AUTOFON_TELEGRAM_CHAT_ID``, ``AUTOFON_API_KEY``, ``AUTOFON_API_PASSWORD``.
+
+выполнить команду ``docker-compose up -d``
+
+## Доступные параметры
+
+| Параметр                                   | Описание                                                                                                                                                        |
+|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| AUTOFON_TELEGRAM_TOKEN                     | Токен телеграм бота, полученный у [@BotFather](https://t.me/BotFather)                                                                                          |
+| AUTOFON_TELEGRAM_CHAT_ID                   | Идентификатор чата, куда бот будет слать уведомления. Обычно это ваш чат с ботом, можно воспользовать [@userinfobot](https://t.me/userinfobot) для получения id |
+| AUTOFON_API_KEY                            | Api ключ АвтоФон, узнать можно в [личном кабинете АвтоФон](https://control.autofon.ru/options/) - API Key                                                       |
+| AUTOFON_API_PASSWORD                       | Пароль от вашего аккуанта АвтоФон                                                                                                                               |
+| AUTOFON_TIME_ZONE                          | Временная зона [ZoneId](https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html), по умолчанию ``Europe/Moscow``                                        |
+| AUTOFON_HEARTBEAT_ENABLED                  | Включить отправку уведомлений о состоянии бота, по умолчанию ``false``                                                                                          |
+| AUTOFON_HEARTBEAT_INTERVAL_SECONDS         | Интервал отправки уведомлений о состоянии бота в секундах, по умолчанию ``10800`` (3 часа)                                                                      |
+| AUTOFON_CHECK_LAST_UPDATE_INTERVAL_SECONDS | Интервал проверки обновлений устройств в секундах, по умолчанию ``600`` (10 минут)                                                                              |

src/main/docker/app.yml → src/main/docker/docker-compose.yml

@@ -1,7 +1,7 @@
 version: '2'
 services:
   autofon-bot-app:
-    image: autofon-telegram-bot:latest
+    image: trueromancha/autofon-telegram-bot:latest
     volumes:
       - /opt/autofon/:/autofon/
     environment: