Usage instruction + TODO

2025-05-06 12:47:11 +05:00 · 2025-05-06 12:47:11 +05:00 · 6656736758
parent 06627b69ff
commit 6656736758
1 changed files with 19 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1,4 +1,22 @@
-# TODO
+# Usage
+
+Создать файл .env в корневой дирректории проекта, объявить и присвоить значения переменным:
+
+TOKEN=
+LOCK_IP=
+CARD_ID=
+AUTH_API=
+
+, где
+
+TOKEN - токен телеграм для взаимодействия с ботом
+LOCK_IP - ip адресс замка
+CARD_ID - уникальный номер ключ-карты
+AUTH_API - уникальный набор символов, для взаимодействия с API замка
+
+Дополнительные подробности можно найти в instruction_http_api_v5.pdf и исходном коде программы (см. main.py)
+
+## TODO

 - [x] Написать базовый функционал
 - [ ] Создать соотношение типа "id_пользователя: досутп_к_замку:"