Create README.md

1 files changed, 59 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a892dd1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+<h1 align="center">Welcome to Binance Spot Order Notifier via Telegram👋</h1>
+<h2>Binance does not currently offer notifications when orders are created, cancelled or fulfilled etc.. With this repo you will receive telegram notifications for your binance spot order status.</h2>
+<p>
+  <img alt="Version" src="https://img.shields.io/badge/version-1.0-blue.svg?cacheSeconds=2592000" />
+  <a href="https://github.com/PiyushDixit96/binance-order-notifier/blob/main/LICENSE" target="_blank">
+    <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
+  </a>
+  <a href="https://twitter.com/PiyushDixit_" target="_blank">
+    <img alt="Twitter: PiyushDixit_" src="https://img.shields.io/twitter/follow/PiyushDixit_.svg?style=social" />
+  </a>
+</p>
+
+> This repo send TELEGRAM ALERTS for BINANCE ORDER STATUS like CREATED, PARTIALLY FILLED, FILLED, CANCELLED, PENDING CANCEL, REJECTED, EXPIRED etc.
+
+<h2>Deploy to Heroku</h2>
+
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/PiyushDixit96/binance-order-notifier)
+
+
+<h2>Setup before Depoly to Heroku</h2>
+
+<h4>SETUP TELEGRAM BOT</h4>
+
+1. Create account on Telegram (skip if you have)
+2. Create Telegram Bot Goto [Bot help](https://core.telegram.org/bots#3-how-do-i-create-a-bot) follow steps at the END Copy **TOKEN**
+3. Open created Bot and click **START**
+4. Goto @getuseridbot and and click **START** and copy **NUMERIC VALUE** this is your **CHAT ID**
+
+<h4>SETUP BINANCE ACCOUNT</h4>
+
+1. [Signup](https://www.binance.com/en/register?ref=35219097) for Binance (skip if you have)
+2. Enable Two-factor Authentication (skip if you done already)
+3. Go API Center, [Create New](https://www.binance.com/en/my/settings/api-management?ref=35219097) Api Key and follow steps and at the END, SET API restrictions to  **ENABLE READING ** only
+4. **Copy API Key and Secret Key** save and Nodepad for later use
+
+<h4>DEPOLY TO HEROKU</h4>
+
+1. Create account on Heroku (skip if you have)
+2. Login to Heroku (if your are not)
+3. Click [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/PiyushDixit96/binance-order-notifier)
+4. Follow Steps
+------------
+
+## Author
+
+👤 **Piyush Dixit**
+
+* Twitter: [@PiyushDixit\_](https://twitter.com/PiyushDixit_)
+* Github: [@PiyushDixit96](https://github.com/PiyushDixit96)
+
+## Show your support
+
+Give a ⭐️ if this project helped you!
+
+## 📝 License
+
+Copyright © 2021 [@PiyushDixit96](https://github.com/PiyushDixit96).<br />
+This project is [MIT](https://github.com/PiyushDixit96/binance-order-notifier/blob/main/LICENSE) licensed.
+***