Merge branch 'develop'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "binance-triangle-arbitrage",
-  "version": "5.2.0",
+  "version": "5.2.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/bmino/binance-triangle-arbitrage.git"
@@ -10,7 +10,7 @@
   },
   "engines": {
     "node": "11.10.1",
-    "npm": "6.9.0"
+    "npm": "6.10.0"
   },
   "scripts": {
     "start": "node src/main/Main.js"
@@ -20,5 +20,6 @@
     "node-binance-api": "^0.9.3",
     "pino": "^5.12.6",
     "pino-pretty": "^3.2.0"
-  }
+  },
+  "license": "MIT"
 }

readme.md

@@ -13,7 +13,7 @@ arbitrage opportunities. To disable the HUD, set `HUD.ENABLED` to false.
 
 ### Reading the HUD
 * **Trade** - Three symbols related by exchange rates that are involved in the triangle arbitrage.
-* **Profit** - Percent profit or loss from executing the triangle arbitrage. This does not include trading fees.
+* **Profit** - Percent profit or loss from executing the triangle arbitrage. This includes trading fees specified via `TRADING.TAKER_FEE` config.
 * **AB Age** - Time in seconds since the most recent update of the market ticker relating the first and second symbols in the arbitrage.
 * **BC Age** - Time in seconds since the most recent update of the market ticker relating the second and third symbols in the arbitrage.
 * **CA Age** - Time in seconds since the most recent update of the market ticker relating the third and first symbols in the arbitrage.
@@ -27,8 +27,8 @@ These instructions will get a copy of the project up and running on your local m
 ### Install Prerequisites
 The following dependencies are recommended to run an instance:
 
-1. **NodeJS** - 11.8.0
-2. **Npm** - 6.7.0
+1. **NodeJS** - 11.10.0
+2. **Npm** - 6.10.0
 
 
 ### Obtain the Codebase
@@ -43,11 +43,13 @@ The following dependencies are recommended to run an instance:
 All configuration is done inside the `/config` directory.
 To setup your configuration for the first time, duplicate the `config.json.example` file and remove the ".example" extension.
 This process must be done before deploying the app for the first time and redone after each major version update where the configuration has changed.
-More details can be found [here](config/readme.md).
+Explanations of each value can be found [here](config/readme.md).
 
+### Assumptions
+1. All fees are [paid via BNB balance](https://binance.zendesk.com/hc/en-us/articles/115000583311)
+2. Sufficient quantity of BNB is maintained during the runtime of the bot
 
 ### Deployment
-
 1. Install project dependencies
     ```
     cd binance-triangle-arbitrage
@@ -63,7 +65,7 @@ More details can be found [here](config/readme.md).
 ## Execution strategies
 There are two supported methods of executing an identified triangle arbitrage opportunity. More details [here](src/resources/docs/strategies.md)
 
-* **Linear** - Three trades are executed sequentially with each being initiated after the first has completed
+* **Linear** - Three trades are executed sequentially with each being initiated after the previous has completed
 * **Parallel** - Three trades are executed asynchronously with each being initiated at the same time
 
 
@@ -82,7 +84,7 @@ See also the list of [contributors](https://github.com/bmino/binance-triangle-ar
 
 ## Donations
 The developers listed above created and currently maintain this project for free.
-We don't expect any compensation nor donations, but if you appreciate our work feel free to donate to the following addresses:
+I don't expect any compensation nor donations, but if you appreciate my work feel free to donate to the following addresses:
 
 * Bitcoin (BTC): 1KLBb9qzFN19RxaQwD35CQmnYZvW1819XZ
 * Binance Coin (BNB): 0xb046b6991eb1bdc838cae567cff838b542e9f19d