Readme Update

This commit is contained in:
Shihaam Abdul Rahman 2021-05-13 22:57:53 +05:00
parent bffff8f70d
commit 74b8f42153

View File

@ -4,31 +4,25 @@
### Requriements
`curl` `jq`
- 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.
### Is it safe?
- Probably, I will not take resposibilty to whatever you do with this script, Understand how this works before proceeding.
### Setup
```
git clone https://github.com/shihaamabr/bml-tg-notify.git
cd bml-tg-notify
chmod +x bml-tg-notify.sh
./bml.sh
mv env.sample .env
```
- `mv env.sample .env`
- Edit the contents of .env to your config\
#### .env Sample
- 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.
```
BML_USERNAME='' #Your BML Username
BML_PASSWORD='' #Your BML Password
BML_ACCOUNTID='' #Your BML Account ID, NOT ACCOUNT NUMBER!
CURRENCY='MVR' #Change if you're setting to a USD Account.
TG_BOT_TOKEN='' #Your Telegram Bot token, This can be optiained by talking to BotFather on Telegram https://t.me/BotFather
TG_CHATID='' #Your Telegram Chat ID
```
`echo XX > delay`
- where XX is the time in seconds you want to delay script run.\
- Please note that if the XX value is less than a certain value, you could get rate limited.
```
chmod +x bml-tg-notify.sh
./bml-tg-notify.sh
```