From d3940ee5dd02b8d56e8c7c696f04f7b8e5e69e2d Mon Sep 17 00:00:00 2001
From: Shihaam Abdul Rahman <shihaam_ab_r@outlook.com>
Date: Mon, 29 Nov 2021 19:40:06 +0500
Subject: [PATCH] update readme

---
 README.md | 34 ++++++++++++++++++++++++++++++++--
 1 file changed, 32 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index ea7a590..01f25da 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,33 @@
-# bml-status-tg-bo
+# BML Telegram Status Bot
 
-Alters BML down for maintenance on telegram.
\ No newline at end of file
+## Alert BML Online/Down for maintanace on Telegram
+
+## Getting started.
+### Requriements
+`curl` `jq` `screen`
+- Install with whatever package manager you use.
+- Make SURE they are installed before continuing!
+### Clone repo and Configure
+```
+git clone https://git.shihaam.dev/shihaam/bml-status-tg-bot.git
+cd bml-status-tg-bot
+chmod +x run-bml-status-tg-bot.sh
+cp env.sample .env
+```
+- Edit the contents of .env to your config (`nano .env`)
+
+### Execute the script
+```
+./run-bml-status-tg-bot.sh
+```
+- This will run the script inside a screen called "bml-status-tg-bot"
+- Access screen with `screen -R bml-status-tg-bot`
+
+### Auto start
+- Add a cronjob at reboot `crontab -e`
+```
+@reboot /bin/bash /path/to/run-bml-status-tg-bot.sh
+```
+
+## Bugs
+- [You tell me :)](https://git.shihaam.dev/shihaam/bml-status-tg-bot/issues/new)