shihaam/bml-tg-notify
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

clean readme

Browse Source
This commit is contained in:
Shihaam Abdul Rahman 2021-05-14 05:36:04 +05:00
parent 79caf75299
commit e4890d4606
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -12,11 +12,12 @@ Anyone who has access (or gains access) to your server or computer can read .env
- Script ONLY sends notification for last transaction, so if there more than 1 transacation when script runs, - Script ONLY sends notification for last transaction, so if there more than 1 transacation when script runs,
you will get notification for the last one only. you will get notification for the last one only.
### There's catch! ### There's catch!
- BML do NOT allow you to be logged in more than 1 device at a time, - BML do NOT allow you to be logged in more than 1 session at a time,
So when this script runs and if you were using Mobile App or Website you will be logged out! 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, You either get fast notification but with less time to use app
This can be delay can be configured later. 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. OR take as much as time you want to use app but slow notifications.
Which is why I have added a delay to change how often script logs into account,
This can be delay can be configured later.
## Getting started. ## Getting started.
### Requriements ### Requriements
@ -37,10 +38,10 @@ cp env.sample .env
./bml-tg-notify.sh ./bml-tg-notify.sh
``` ```
- Maybe run in a screen to run in background? - Maybe run in a screen to run in background?
## Setting Delay - Optional ### Setting Delay - Optional
- `echo XX > delay` where XX is the time in seconds you want to delay script runs, - By default delay is set to 160.
By default this is set to 160. Please note that if the XX value is less than a certain value (I think 15) - In a new terminal run `echo XX > delay` where XX is the time in seconds you want to delay script runs,
your IP could get blocked by CloudFlare for DoS attack. - Please note that if the XX value is less than a certain value (I think 15) your IP could get blocked by CloudFlare for DoS attack.
- You do not need to restart script after changing delay. - You do not need to restart script after changing delay.
## Bugs ## Bugs
- [You tell me :)](https://github.com/shihaamabr/bml-tg-notify/issues/new) - [You tell me :)](https://github.com/shihaamabr/bml-tg-notify/issues/new)