From 471d3c7d9aca339771df7830d070b44f3ea66b57 Mon Sep 17 00:00:00 2001
From: levina <82658782+levina-lab@users.noreply.github.com>
Date: Sat, 19 Feb 2022 07:23:33 +0700
Subject: [PATCH] readme

---
 README.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 75 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 57e41b3..504b747 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 <p align="center"><a href="https://t.me/VeezVideoBot"><img src="https://github.com/levina-lab/video-stream/raw/main/driver/veezlogo.png"></a></p>
 <p align="center">
-    <br><b>Video Stream is an Open-Source Telegram Bot project that's allow you to play Video & Music on Telegram Group Video Chat</b><br>
+    <br><b>Video Stream is an Open-Source Telegram Bot project that's allow you to play Video & Music trough the Telegram Group Video Chat</b><br>
 </p>
 <p align="center">
     <a href="https://www.codefactor.io/repository/github/levina-lab/video-stream"> <img src="https://www.codefactor.io/repository/github/levina-lab/video-stream/badge?color=red&logo=codacy&style=flat-square" alt="CodeFactor" /></a>
@@ -14,17 +14,84 @@
     <a href="https://github.com/levina-lab/video-stream/network/members"> <img src="https://img.shields.io/github/stars/levina-lab/video-stream?color=red&logo=github&logoColor=blue&style=flat-square" /></a>
 </p>
 
+## Deployment
+Read the [Docs](https://levina.gitbook.io/videostreambot/deployment/requirements) for Detailed Information and Setup Guide on deploying Bot.
 
-# Credits
+> Click on buttons to Expand!
+<details>
+<summary><b>🔗 Requirements</b></summary>
+<br>
 
-- [Levina](https://github.com/levina-lab) ``Dev``
-- [Zxce3](https://github.com/Zxce3) ``Dev``
-- [tofikdn](https://github.com/tofikdn) ``Dev``
-- [Laky's](https://github.com/Laky-64) for [``py-tgcalls``](https://github.com/pytgcalls/pytgcalls)
-- [Dan](https://github.com/delivrance) for [``Pyrogram``](https://github.com/pyrogram)
+- [Python3.9](https://www.python.org/downloads/release/python-390/)
+- [Telegram API Key](https://docs.pyrogram.org/intro/setup#api-keys)
+- [Telegram Bot Token](https://t.me/botfather)
+- [MongoDB URL](https://telegra.ph/How-to-Get-mongodb-url-02-18)
+- [Pyrogram Session String](https://levina.gitbook.io/videostreambot/deployment/string-session)
+    
+</details>
 
-# Contact & Support
+<details>
+<summary><b>🔗 Session String</b></summary>
+<br>
+
+> You'll need a [API_ID](https://levina.gitbook.io/videostreambot/vars/vars-information#1.-api_id) & [API_HASH](https://levina.gitbook.io/videostreambot/vars/vars-information#2.-api_hash) in order to generate pyrogram session string. 
+> Always remember to use good API combo else your account could be deleted.
+
+<h4> Generate Session via Repl.it: </h4>    
+<p><a href="https://replit.com/@levinalab/Session-Generator?lite=1&outputonly=1#main.py"><img src="https://img.shields.io/badge/Generate%20On%20Repl-blueviolet?style=for-the-badge&logo=appveyor" width="200""/></a></p>
+
+</details>
+
+<details>
+<summary><b>🔗 Deploy to Heroku</b></summary>
+<br>
+
+> Heroku has blacklisted this repository, That's why you get policy error message while pressing the Deploy Button. So the solution is you'll need to Fork this repo first and tap the Deploy Button from your forked repo. Click the fork button in the upper right corner next to the star button to fork this Repo.
+
+<h4>Click the button below to deploy Bot on Heroku!</h4>    
+<p><a href="https://heroku.com/deploy"><img src="https://img.shields.io/badge/Deploy%20To%20Heroku-blueviolet?style=for-the-badge&logo=heroku" width="200""/></a></p>
+
+</details>
+
+<details>
+<summary><b>🔗 Deploy to VPS</b></summary>
+<br>
+
+> Checkout the [Docs](https://levina.gitbook.io/videostreambot/deployment/local-hosting-or-vps) for Detailed Explanation on VPS Deployment
+
+```console
+root@linux~ $ git clone https://github.com/levina-lab/video-stream
+root@linux~ $ cd video-stream
+root@linux~ $ pip3 install -U -r requirements.txt
+root@linux~ $ cp example.env .env
+```
+> Edit .env with your own values and then start bot with
+```console
+root@linux~ $ python3 main.py
+```
+
+</details>
+
+## Config Vars
+- Checkout all [Available Vars](https://levina.gitbook.io/videostreambot/vars/available-vars)
+- Checkout the [Vars Information](https://levina.gitbook.io/videostreambot/vars/vars-information)
+- Checkout some [Configs](https://levina.gitbook.io/videostreambot/setup-config/config)
+
+## Contact & Support
 
 <a href="https://t.me/VeezSupportGroup"><img src="https://img.shields.io/badge/Join-Group%20Support-blue.svg?style=for-the-badge&logo=Telegram"></a><br>
 <a href="https://t.me/levinachannel"><img src="https://img.shields.io/badge/Join-Updates%20Channel-blue.svg?style=for-the-badge&logo=Telegram"></a><br>
 <a href="https://t.me/dlwrml"><img src="https://img.shields.io/badge/Contact-Repo%20Owner-blue.svg?style=for-the-badge&logo=Telegram"></a>
+
+## License
+
+Distributed under the [GNU General Public License v3.0 License](https://github.com/levina-lab/video-stream/blob/main/LICENSE) See `LICENSE.md` for more information.
+
+## Credits
+
+- [Levina](https://github.com/levina-lab) ``Dev``
+- [Zxce3](https://github.com/Zxce3) ``Dev``
+- [tofikdn](https://github.com/tofikdn) ``Dev``
+- [Xtao_dada](https://github.com/xtaodada) ``Dev``
+- [Laky's](https://github.com/Laky-64) for [``py-tgcalls``](https://github.com/pytgcalls/pytgcalls)
+- [Dan](https://github.com/delivrance) for [``Pyrogram``](https://github.com/pyrogram)