Update README.md

README.md

@@ -14,20 +14,27 @@ Working demo telegram channel: https://t.me/binance_pump_alerts (Hosted on AWS e
 4. Add pairs to watch into watchlist or leave it empty to monitor all tickers on binance
 5. Run "pumpAlerts.py" with command `python pumpAlerts.py`
 
-## Main Customizable Params
-
-1. chartIntervals: Can be modified to consider other timeframes, follow the format of 's' for second, 'm' for minute, 'h' for hour
-2. Outlier param: (0.01 -> 1% , 0.10 -> 10%), modify accordingly based on needs. Avoid setting it too low or there might be quite a bit of spam.
-3. Pairs of interest: Default is USDT and BTC,
-4. HardAlertMin: Default '15s' will not trigger another alert within same pair for the specified duration
-5. ResetInterval: Default '3h', clears the array used to store data points to prevent MEM ERROR (Still testing), customizable as well
-6. Debug: Default 'True', sends extraction messages and duration
 
 ### Mandatory Params
 
 1. TelegramToken: Telegram bot telegramToken obtained from @BotFather
 2. TelegramChatId: Bot will send message to this id, it can be a group or channel as well. To get personal telegramChatId, get it from @get_id_bot
 
+
+## Main Customizable Params
+
+1. chartIntervals: Can be modified to consider other timeframes, follow the format of 's' for second, 'm' for minute, 'h' for hour
+2. Outlier param: (0.01 -> 1% , 0.10 -> 10%), modify accordingly based on needs. Avoid setting it too low to avoid noise
+3. extractInterval: Default '1s' , interval at which we get the price information from Binance
+4. Pairs of interest: Default is USDT (Other options include BTC, ETH etc)
+
+
+### Alert Interval Params
+
+1. hardAlertIntervalEnabled: (Main) Prevents triggering of same interval for the timeframe of the interval. E.g. '5m' triggers. Will not trigger intervals >= '5m' for 5 minutes. Other intervals < '5m' such as '1s' , '5s' will continue being triggered.
+2. HardAlertMin: (Legacy) Set hardAlertIntervalEnabled to false to enable this. Does not trigger another alert within same pair for the specified duration
+
+
 ### Optional features to enable
 
 1. Watchlist: Default if left empty it'll look at ALL symbols after filtering by pairs of interest. If pairs are added to watchlist, program will **only track the pairs specified**.
@@ -42,6 +49,15 @@ Working demo telegram channel: https://t.me/binance_pump_alerts (Hosted on AWS e
 4. TelegramAlertChatId: Insert Chat ID for top pump dump alert, if left at 0 it'll send to telegramChatId
    For params not indicated above, refer to comments besides parameter for its use.
 
+#### Debug Params (Avoid modifying if possible)
+1. Debug: Default 'False', only enable for debugging. Logging set to info level message and above
+2. ResetInterval: Default '12h', clears the array used to store data points to prevent MEM ERROR
+3. priceRetryInterval: Default '1s' # In the case of get price fail, this is the time delay before re-attempt
+4. telegramRetryInterval: Default '1s' # If telegram message fails to send, this is the time delay before re-attempt
+5. tdpaInitialBuffer: Default '5m' # Initial buffer before we trigger TDPA. Prevents all 0% output due to lack of data points
+6. checkNewListingEnabled: True # Disables checking and adding of new listing pairs. 
+
+
 ---
 
 ## Todo
@@ -63,3 +79,4 @@ Working demo telegram channel: https://t.me/binance_pump_alerts (Hosted on AWS e
 10. Allows long period of running without MEM ERROR
 11. Send periodic Top X dumped / pumped coins
 12. Docker Integration (Thanks to @patbaumgartner)
+13. Logging Integration (Thanks to @patbaumgartner)