Showing 1 changed files with 16 additions and 10 deletions
+16 -10
README.md
... ...
@@ -1,10 +1,14 @@
1 1
 # Binance Stepper Bot
2 2
 
3
-The 'binance-stepper-bot' ...
3
+The 'binance-stepper-bot' is a **trading automation program** for [Binance Exchange](https://www.binance.com/en) written in Python.
4 4
 
5
-### Setting up
5
+It is designed to be robust and reliable, so it only utilizes usual Sell and Buy limit orders, each following trade is placed based on the pre-generated array of prices and has only two orders out on the market at the same time.
6 6
 
7
-##### Bot-side
7
+Program is capable of sending you a daily/weekly/monthly reports with the number of completed trades and estimated profit. It also saves each and every order it places on the market, thus creating monthly trading history.
8
+
9
+## Setting up
10
+
11
+#### Bot-side
8 12
 
9 13
 1. Make sure you have Python >= 3.7 installed
10 14
 2. Download all the repository files to your machine or clone it:
... ...
@@ -33,7 +37,9 @@ service-identity
33 37
 Twisted
34 38
 ```
35 39
 
36
-##### Exchange-side
40
+4. Make sure that you have set a correct local time on your machine to avoid _server time-stamp_ errors
41
+
42
+#### Exchange-side
37 43
 
38 44
 1. [Register/Log-in](https://accounts.binance.com/en/login) to Binance Exchange
39 45
 2. Apply all the necessary security measures to protect your account, including Two-Factor Authentication.
... ...
@@ -47,17 +53,17 @@ Optional: Consider restricting API access to trusted IPs only
47 53
 
48 54
 4. Save your API and Secret keys
49 55
 
50
-##### Email-side
56
+#### Email-side
51 57
 
52
-As this bot uses Gmail as SMTP provider, follow the steps to allow it to send you reports.
58
+This bot can send you reports based on its activity on the market. It uses Gmail as SMTP provider, meaning that you have to have at least one Gmail account in order to unitize it for emailing. Follow the steps to allow it to send you reports.
53 59
 
54 60
 1. [Allow less secure apps](https://www.google.com/settings/security/lesssecureapps) to access your account
55 61
 2. [Display unlock captcha](https://accounts.google.com/DisplayUnlockCaptcha) to prevent _SMTPAuthenticationError_ with code 534
56 62
 
57
-### Configuration
63
+## Configuration
58 64
 
59
-### Usage
65
+## Usage
60 66
 
61
-### Trading Algorithm
67
+## Trading Algorithm
62 68
 
63
-### Disclaimer
69
+## Disclaimer