From 33d0f274dea7861aaf14f961097d72ccf9cc14f6 Mon Sep 17 00:00:00 2001
From: Listum <listum@orudo.ru>
Date: Thu, 2 Nov 2023 14:41:00 +0300
Subject: [PATCH] =?UTF-8?q?=D0=9E=D1=84=D0=BE=D1=80=D0=BC=D0=BB=D0=B5?=
 =?UTF-8?q?=D0=BD=D0=B8=D0=B5=20README.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 52 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 36c3c46..31a7980 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,55 @@
-# aur_builder_bot
+# Aur Builder Bot
+
+## Описание
 
 Реинкарнация мёртвого питон проекта на расте.
 
-Телеграм бот для сёрфинга/парсинга AUR и компиляции пакетов, а потом добавления их в личный репозиторий в виде бинарников.
\ No newline at end of file
+Телеграм бот для сёрфинга/парсинга AUR и компиляции пакетов, а потом добавления их в личный репозиторий в виде бинарников.
+
+
+## Настройка
+
+### Standalone
+
+1. Укажите токен бота телеграм
+```bash
+# Unix-like
+$ export TELOXIDE_TOKEN=<Your token here>
+
+# Windows command line
+$ set TELOXIDE_TOKEN=<Your token here>
+
+# Windows PowerShell
+$ $env:TELOXIDE_TOKEN=<Your token here>
+```
+
+3. Запустите бота
+```bash
+./aur_builder_bot
+```
+4. Создайте симлинк до вашего локального репозитория
+```bash
+ln -s /path/to/bot/repo /path/to/repo
+```
+
+### Docker
+
+#### В разработке
+
+## Использоание
+
+1. Поиск пакетов в AUR
+`/search <название пакета>`
+
+2. Добавление пакетов в репозиторий
+`/upload <название пакета>`
+
+
+## Сторонние библиотеки
+
+<ul>
+  <li>(Teloxide)[https://crates.io/crates/teloxide]</li>
+  <li>(Git2)[https://crates.io/crates/git2]</li>
+  <li>(Aur_rpc)[https://crates.io/crates/aur-rpc]</li>
+  <li>(Glob)[https://crates.io/crates/glob]</li>
+</ul> 
\ No newline at end of file