From aacd22cf9eab48361836c9d15389bb11d34c2b2c Mon Sep 17 00:00:00 2001 From: fabcx <64059956+fabcx@users.noreply.github.com> Date: Tue, 21 Apr 2020 16:29:54 +0200 Subject: [PATCH] Update README.md Readme update --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0822f68..7c6d48d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ -# TradingView-Webhook-Bot -This bot listens to TradingView alerts via webhooks and sends them instantly to Telegram and/or Discord. +# TradingView Webhook Bot + +![Python3](https://img.shields.io/badge/python-3-blue.svg) +![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg) + +This bot listens to [TradingView](https://tradingview.com) alerts via webhooks and sends them instantly to Telegram and/or Discord. + +## Usage +1. Clone this repository `git clone https://github.com/fabcx/TradingView-Webhook-Bot.git` +2. Create your virtual environment `python3 -m venv TradingView-Webhook-Bot +3. Activate it `source TradingView-Webhook-Bot/bin/activate` +4. Install all requirements `pip install -r requirements.txt` +5. Edit and update the `config.py` file +6. Setup TradingView alerts as shown [here](https://i.imgur.com/QpAP3wp.png) + - Your webhook url would be `http://YOUR-IP/webhook` +7. Run the bot `python main.py` + +*It is recommended to run flask on a different port like 8080. It is then necessary to forward port 80 to 8080.* + +## Donations +BTC: `13VmcVh7U3y7UQiUGp1nnyn6Pz9TPR61a9`