Skip to content

Commit

Permalink
Merge pull request gmverdon#23 from gmverdon/feature/readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
gmverdon authored Jan 31, 2018
2 parents 1b3d34a + 42c8571 commit 56984dd
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[![npm](https://img.shields.io/npm/v/npm.svg)]()
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/gmverdon/TradingBot/issues)

For as now this trading bot only supports [Binance](https://www.binance.com). To use this bot follow these steps:
For as now this trading bot only supports [Binance](https://www.binance.com). It is important to note that this bot is not finished and that the bot cannot trade with real money yet. To use this bot follow these steps:

## 1. Cloning

Expand All @@ -26,8 +26,11 @@ BINANCE_SECRET = ...
npm start
```

## 4. Change variables (optional)
Go to lib/bot.js and change the variables in the constructor.
## 4. Accept Binance connection (Know problem)
Currently the Binance API does not have a CORS (Cross-Origin Resource Sharing) header. This results into connection problems when connecting from a browser to their API. If you also have this problem you can try installing a browser plugin which includes the Allow-Control-Allow-Origin: * header clientside. Unfortunately, even with this plugin, it is currently not possible to trade with real money. *I have already informed Binance about this problem*.

## 5. Happy Trading
Use at your own risk.

## Legal Note
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 comments on commit 56984dd

Please sign in to comment.