From 295493ab41ccb28dd8ef3b0e2e382e9f07e381ee Mon Sep 17 00:00:00 2001
From: Keroosha <mr.dead.toast@gmail.com>
Date: Mon, 27 Feb 2023 01:02:44 +0300
Subject: [PATCH] README.md

---
 PublishHelperBot/config.example.json |  4 +-
 README.md                            | 73 ++++++++++++++++++++++++++++
 2 files changed, 76 insertions(+), 1 deletion(-)

diff --git a/PublishHelperBot/config.example.json b/PublishHelperBot/config.example.json
index fc755fc..afa1315 100644
--- a/PublishHelperBot/config.example.json
+++ b/PublishHelperBot/config.example.json
@@ -1,5 +1,7 @@
 {
   "token": "abba",
   "chanelId": "123123123",
-  "adminChatId": "123123123"
+  "adminChatId": "123123123",
+  "relayUrl": "https://t.me/pokupkabitka_bot",
+  "youtubeDlUrl": "http://localhost:8000/"
 }
\ No newline at end of file
diff --git a/README.md b/README.md
index 8782b06..ee15786 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,74 @@
 # PublishHelperBot
+
+## Префасе
+
+Вспомогательный бот для публикации контента в СБПБ
+
+## Setup
+
+### Необходимый хлам
+
+- клинекс)
+- Петухон 3.10.9
+- [Dotnet SDK 7.0](https://dotnet.microsoft.com/en-us/download/dotnet/7.0)
+- poetry
+
+### Зависимости
+
+```bash
+cd yotube-dl-api && poetry install && cd .. &&\ 
+cd PublishHelperBot && dotnet restore
+```
+
+### Конфиг
+
+см. *config.example.json* в папке проекта бота
+
+```json
+{
+  "token": "abba", // Хуйня от ботфазера
+  "chanelId": "123123123", // Канал куда постить
+  "adminChatId": "123123123", // Чат откуда будут слушаться команды
+  "relayUrl": "https://t.me/pokupkabitka_bot", // ссылка на бота предложки (Нужно команде /post)
+  "youtubeDlUrl": "http://localhost:8000/" // апишка для скачивания видосиков
+}
+```
+
+### Собираем жигу
+
+```bash
+cd PublishHelperBot && dotnet build -c Release -o ../out
+```
+
+### Заводим жигу
+
+#### Сам бот
+
+```bash
+./SBPB_CONFIG_PATH=config.prod.json ./PublishHelperBot 
+```
+
+#### YotubeDL апишка
+
+```bash
+poetry shell
+uvicorn youtube_dl_api:app
+```
+
+### Контрибушен
+
+Делай форк, кидай ПР, ~~еби гусей~~, мы посмотрим
+
+### Код оф кондукт
+
+Мы против буллинга, хуюлинга и Бориса Юлинга!
+
+## Кредитс
+
+Я в шоке с контента если честно
+
+[Канал](https://t.me/pokupkabitka)
+
+[Предложка](https://t.me/pokupkabitka_bot)
+
+[Лэндинг паге](https://супербиток.сука.сайт/)
\ No newline at end of file