From bae7ec8d09a773c9b820a13f673ac02d20f256a3 Mon Sep 17 00:00:00 2001 From: Shihaam Abdul Rahman Date: Thu, 13 May 2021 23:22:04 +0500 Subject: [PATCH] more detailed readme --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d373702..d9a52ce 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# BML-TG-NOTIFICATION +# BML-TG-NOTIFY ## Push Notification BML Transcations to Telegram ### Requriements @@ -6,12 +6,16 @@ - Install with whatever package manager you use. ### There's catch! -- BML do NOT allow you to be logged in more than 1 device at a time, So when this script runs and if you were using Mobile App or Website you will be logged out! \ -Which is why I have added a delay to change how often script logs into account and check for new transactions, This can be configured when you set up. \ -You either get fast notification but with less time to use app to do whatever you do OR take as much as time you want to use app but slow notifications. +- BML do NOT allow you to be logged in more than 1 device at a time, +So when this script runs and if you were using Mobile App or Website you will be logged out! +Which is why I have added a delay to change how often script logs into account and check for new transactions, +This can be configured when you set up. You either get fast notification but with less time to use app to do whatever you do +OR take as much as time you want to use app but slow notifications. ### Is it safe? -- Probably, I will not take resposibilty to whatever you do with this script, Understand how this works before proceeding. +- Probably, I will NOT take resposibilty to whatever you do with this script, +Understand how this works before proceeding. Your BML Username and Password will be saved in PLAIN TEXT! +Anyone who has access (or gains access) to your server or computer can read .env file and optain your BML login credentials! ### Setup ``` @@ -20,8 +24,12 @@ cd bml-tg-notify chmod +x bml-tg-notify.sh mv env.sample .env ``` -- Edit the contents of .env to your config `nano .env` -- Optionally edit delay `echo XX > delay` where XX is the time in seconds you want to delay script run, By default this is set to 160. Please note that if the XX value is less than a certain value, your IP could blocked by CloudFlare for DoS attack. +- Edit the contents of .env to your config with text editor of your choosing (`nano .env`) +### How to get "BML_ACCOUNTID" + +- Optionally edit delay `echo XX > delay` where XX is the time in seconds you want to delay script run, +By default this is set to 160. Please note that if the XX value is less than a certain value +your IP could blocked by CloudFlare for DoS attack. ``` ./bml-tg-notify.sh ```