From 98b621b39d12a9aa68d590986618dbf71894c6ba Mon Sep 17 00:00:00 2001
From: StNicolay <stnicolay2007@mail.ru>
Date: Fri, 21 Oct 2022 19:03:27 +0300
Subject: [PATCH] =?UTF-8?q?=D0=98=D0=B7=D0=BC=D0=B5=D0=BD=D0=B5=D0=BD?=
 =?UTF-8?q?=D0=B8=D1=8E=20README.md,=20=D0=B4=D0=BE=D0=B1=D0=B0=D0=B2?=
 =?UTF-8?q?=D0=B8=D0=BB=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD=D1=82?=
 =?UTF-8?q?=D0=B0=D1=86=D0=B8=D1=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 36 +++++++++++++++++++++++++-----------
 1 file changed, 25 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 408fee8..b8c0c7f 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,32 @@
 # PassManager
 
-### Цель
+## Описание
 
-**Создать бота для сохранения, созания паролей в зашифрованой базе данных.**
+Менеджер паролей для телегам, где все пароли надёжно зашифрованы
 
-### Задачи
+## Документация
 
-* Создать телеграм бота
-* Научить его работать с БД (MariaDB)
-* Зашифровать БД
-* Сделать общедоступным
+### База данных
 
-### Инструменты
+В качестве базы данных данный бот использует mariadb, к которой бот должен иметь доступ всегда
 
-* Язык программирования Python
-* PyTelegramBotAPI
-* MariaDB
\ No newline at end of file
+### Команды и их синтаксис
+
+- /set_master_pass {Мастер пароль} - установить мастер пароль
+- /add_account {Название} {Логин} {Пароль} {Мастер пароль} - создать аккаунт
+- /get_accounts - получить список аккаунтов
+- /get_account {Название} {Мастер пароль} - получить логин и пароль аккаунта
+- /delete_account {Название} - удалить аккаунт
+- /delete_all - удалить все аккаунты и мастер пароль
+- /reset_master_pass {Новый мастер пароль} - удалить все аккаунты и изменить мастер пароль
+
+### Настройка
+
+Настройка питизводится через переменные среды. Их можно прописать в файле .env, если не хотите задавать их каждый раз в случае, если вы не работаете с Docker
+
+#### Переменные среды
+
+- DB_HOST - ip адрес базы данных
+- DB_USER - пользователь базы данных
+- DB_PASS - пароль пользователя базы данных
+- DB_NAME - название базы данных