partial doc update
This commit is contained in:
		
							
								
								
									
										17
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										17
									
								
								README.md
									
									
									
									
									
								
							@@ -11,13 +11,9 @@ Anyone who has access (or gains access) to your server or computer can read .env
 | 
			
		||||
- At the moment this script can only check 1 account from personal profile.
 | 
			
		||||
- Script ONLY sends notification for last transaction, so if there more than 1 transacation 
 | 
			
		||||
when script checks for new transactions you will get notification for the last one only.
 | 
			
		||||
### There's catch!
 | 
			
		||||
- 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!
 | 
			
		||||
- You either get fast notification but with less time to use app 
 | 
			
		||||
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. [See how](#setting-delay---optional)
 | 
			
		||||
- If you login to web or mobile app while script is running, It will pause for APP_NORMAL_DELAY seconds befor running again. 
 | 
			
		||||
 | 
			
		||||
## Getting started. 
 | 
			
		||||
### Requriements
 | 
			
		||||
@@ -31,19 +27,16 @@ cd bml-tg-notify
 | 
			
		||||
chmod +x bml-tg-notify.sh
 | 
			
		||||
cp env.sample .env
 | 
			
		||||
```
 | 
			
		||||
- Edit the contents of .env to your config (`nano .env`)
 | 
			
		||||
- Edit the content 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)
 | 
			
		||||
### Notes
 | 
			
		||||
- If the NORAML_DELAY value is less than a certain value (I think 15) your IP could get blocked by CloudFlare for DoS attack.
 | 
			
		||||
 | 
			
		||||
### Execute the script
 | 
			
		||||
```
 | 
			
		||||
./bml-tg-notify.sh
 | 
			
		||||
```
 | 
			
		||||
- Maybe run in a screen to run in background?
 | 
			
		||||
## Setting Delay - Optional Configration
 | 
			
		||||
In a different terminal seession run `echo XX > delay` where XX is the time in seconds you want to delay script logs into account [See why](#theres-catch)
 | 
			
		||||
### Notes
 | 
			
		||||
- Default value is 160.
 | 
			
		||||
- 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
 | 
			
		||||
- [You tell me :)](https://github.com/shihaamabr/bml-tg-notify/issues/new)
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user