From 353c136fb7b8ca7c0fe517f4bb4ca196c0106926 Mon Sep 17 00:00:00 2001
From: sixBit <64059956+sixBit@users.noreply.github.com>
Date: Sat, 11 Jul 2020 10:08:51 +0200
Subject: [PATCH] Minor changes to the readme
---
.github/FUNDING.yml | 2 +-
README.md | 25 ++++++++++++++-----------
2 files changed, 15 insertions(+), 12 deletions(-)
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
index 30bb413..afe0981 100644
--- a/.github/FUNDING.yml
+++ b/.github/FUNDING.yml
@@ -1 +1 @@
-custom: ['sixbit.io/paypal', 'sixbit.io/bitcoin']
+custom: ['sixbit.io/paypal', 'sixbit.io/crypto']
diff --git a/README.md b/README.md
index 8c176b2..d17d6db 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@
-
+
@@ -24,28 +24,30 @@
## About -The **TradingView-Webhook-Bot** ⚙️ listens to [TradingView](https://tradingview.com) alerts via [webhooks](https://www.tradingview.com/support/solutions/43000529348-i-want-to-know-more-about-webhooks/) using [flask](https://flask.palletsprojects.com/en/1.1.x/). All alerts can be instantly sent to Telegram, Discord, Twitter and/or Email. +The **TradingView Webhook Bot** ⚙️ listens to [TradingView](https://tradingview.com) alerts via [webhooks](https://www.tradingview.com/support/solutions/43000529348-i-want-to-know-more-about-webhooks/) using [flask](https://flask.palletsprojects.com/en/1.1.x/). All alerts can be instantly sent to Telegram, Discord, Twitter and/or Email. ## Features - Telegram Support using the [Python Telegram](https://github.com/python-telegram-bot/python-telegram-bot) libary - Discord Support using [webhooks](https://support.discord.com/hc/de/articles/228383668-Webhooks-verwenden) -- Twitter Support using [tweepy](https://github.com/tweepy/tweepy) libary +- Twitter Support using the [tweepy](https://github.com/tweepy/tweepy) libary - Email Support using [smtplib](https://docs.python.org/3/library/smtplib.html) - Alert channels can be enabled or disabled in [`config.py`](https://github.com/sixBit/TradingView-Webhook-Bot/blob/master/config.py) - Differentiate between Buy and Sell alerts - TradingView `{{close}}`, `{{exchange}}` etc. variables support. Read more [here](https://www.tradingview.com/blog/en/introducing-variables-in-alerts-14880/) +> 💡 Got a feature idea? Open an [issue](https://github.com/sixBit/Telegram-Webhook-Bot/issues/new) and I might implement it. + ## Installation -> 💡 Best to run the bot on a VPS. I can recommend [vultr](sixbit.io/vultr). +> ⚠️ Best to run the bot on a VPS. I can recommend [vultr](https://sixbit.io/vultr). 1. Clone this repository `git clone https://github.com/sixBit/TradingView-Webhook-Bot.git` -2. Create your virtual environment `python3 -m venv TradingView-Webhook-Bot` -3. Activate it `source TradingView-Webhook-Bot/bin/activate && TradingView-Webhook-Bot` -4. Install all requirements `pip install -r requirements.txt` -5. Edit and update [`config.py`](https://github.com/sixBit/TradingView-Webhook-Bot/blob/master/config.py) -6. Setup TradingView alerts as shown [here](https://i.imgur.com/71UYTcu.png) +1. Create your virtual environment `python3 -m venv TradingView-Webhook-Bot` +1. Activate it `source TradingView-Webhook-Bot/bin/activate && TradingView-Webhook-Bot` +1. Install all requirements `pip install -r requirements.txt` +1. Edit and update [`config.py`](https://github.com/sixBit/TradingView-Webhook-Bot/blob/master/config.py) +1. Setup TradingView alerts as shown [here](https://i.imgur.com/71UYTcu.png) - TradingViews variables like `{{close}}`, `{{exchange}}` etc. work as well. More can be found [here](https://www.tradingview.com/blog/en/introducing-variables-in-alerts-14880/) - Your webhook url would be `http://YOUR-IP/webhook` -7. Run the bot `python main.py` +1. 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.* @@ -53,4 +55,5 @@ The **TradingView-Webhook-Bot** ⚙️ listens to [TradingView](https://tradingv  ## How can I help? -All kinds of contributions are welcome! The most basic way to show your support is to `⭐️ star` the project, or to raise [issues](https://github.com/sixBit/TradingView-Webhook-Bot/issues/new). \ No newline at end of file +All kinds of contributions are welcome! +The most basic way to show your support is to `⭐️ star` the project, or to raise [`🐞issues`](https://github.com/sixBit/TradingView-Webhook-Bot/issues/new). \ No newline at end of file