Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jrc356 authored Jan 20, 2020
1 parent 07d692c commit 7b748a6
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
# Maximus
Trading Bot
An attempt at a NEAT Crypto Currency Trading Bot. This bot utilizes (neat-python)[https://github.com/CodeReclaimers/neat-python] to create a nueral network to trade crypto currencies in a given amount of time.

## Status
This bot is currently useless and the config untuned. To improve upon the bot, play with the parameters in `bot/config`. The best I've gotten so far was about 2% in a couple days time.

## Installation
First, create a virtual env of your choice and run `pip install -r requirements.txt` to install dependencies.

Then, collect the needed data by going into the `data` folder. Then run `collect_data.py` to collect the data needed. The script relies on the open bitfinex api's so a key should not be needed. This will try to collect all of the data laid out in `config.json` (in the top most directory).

Next, edit and run `clean_data.py` to clean up the data and add derivitives such as moving averages and RSI.

Finally, Run the bot using `python3 bot/model.py`

0 comments on commit 7b748a6

Please sign in to comment.