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:12:35 +05:00
parent 8ed515fd30
commit b8275a2de0
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -15,10 +15,10 @@ you will get notification for the last one only.
- 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 device 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, 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 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.
## Setup ## Getting started.
### Requriements ### Requriements
`curl` `jq` `curl` `jq`
- Install with whatever package manager you use. - Install with whatever package manager you use.
@ -30,15 +30,17 @@ cd bml-tg-notify
chmod +x bml-tg-notify.sh chmod +x bml-tg-notify.sh
cp env.sample .env cp env.sample .env
``` ```
- Edit the contents of .env to your config with text editor of your choosing (`nano .env`)\ - Edit the contents of .env to your config (`nano .env`)\
[How to obtain BML_ACCOUNTID](https://raw.githubusercontent.com/shihaamabr/bml-tg-notify/main/how-to-obtain-BML_ACCOUNTID.png) - [How to obtain BML_ACCOUNTID](https://raw.githubusercontent.com/shihaamabr/bml-tg-notify/main/how-to-obtain-BML_ACCOUNTID.png)
- 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 (I think 15)
your IP could get blocked by CloudFlare for DoS attack.
### Execute the script ### Execute the script
``` ```
./bml-tg-notify.sh ./bml-tg-notify.sh
``` ```
- Maybe put in a screen to run in background? - Maybe run in a screen to run in background?
## Setting Delay - Optional
- `echo XX > delay` where XX is the time in seconds you want to delay script runs,
By default this is set to 160. 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.
## 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)