Showing 1 changed files with 21 additions and 4 deletions
+21 -4
README.md
... ...
@@ -2,9 +2,9 @@
2 2
 
3 3
 The 'binance-stepper-bot' is a **trading automation program** for [Binance Exchange](https://www.binance.com/en) written in Python.
4 4
 
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.
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
-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.
7
+Program is capable of sending you 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 8
 
9 9
 ## Setting up
10 10
 
... ...
@@ -37,7 +37,7 @@ service-identity
37 37
 Twisted
38 38
 ```
39 39
 
40
-4. Make sure that you have set a correct local time on your machine to avoid _server time-stamp_ errors
40
+4. Make sure that you have set a correct local time on your machine to avoid server _time-stamp_ errors
41 41
 
42 42
 #### Exchange-side
43 43
 
... ...
@@ -55,13 +55,30 @@ Optional: Consider restricting API access to trusted IPs only
55 55
 
56 56
 #### Email-side
57 57
 
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.
58
+This bot can email 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.
59 59
 
60 60
 1. [Allow less secure apps](https://www.google.com/settings/security/lesssecureapps) to access your account
61 61
 2. [Display unlock captcha](https://accounts.google.com/DisplayUnlockCaptcha) to prevent _SMTPAuthenticationError_ with code 534
62 62
 
63 63
 ## Configuration
64 64
 
65
+The program uses _config.json_ file for basic configuration settings. It is divided in two entries: _Binance\_bot_ and _Email\_sender_.
66
+
67
+| Setting          | Description                                                               |
68
+|------------------|---------------------------------------------------------------------------|
69
+| api_key          | Binance API key                                                           |
70
+| api_secret       | Binance API secret key                                                    |
71
+| asset            | cryptocurrency listed on Binance you want to buy your coin with (ex. BTC) |
72
+| coin             | cryptocurrency listed on Binance you want to sell for you asset (ex. BNB) |
73
+| spread           | number of step values between your BUY and SELL order (ex. 4)             |
74
+| step             | distance between prices (ex. 0.00134)                                     |
75
+| conins_per_order | amount of coin for each trade (ex. 7)                                     |
76
+| sender_address   | email address to send emails from                                         |
77
+| sedner_pass      | password from sender email                                                |
78
+| receiver_adderss | email address to send email to (could be the same as sender address)      |
79
+
80
+Some unimplemented configuration, like: toggle emailing, using different SMTP provider, frequency of report generation should be done by commenting appropriate source code section. For now.
81
+
65 82
 ## Usage
66 83
 
67 84
 ## Trading Algorithm