From 90f935742e3e88b8f59783ee23a830ec4ac38abd Mon Sep 17 00:00:00 2001 From: Luke Wilson Date: Sat, 17 May 2025 08:39:18 -0500 Subject: [PATCH] Fix images in readme --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 65eeb84..43e3e23 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,22 @@ # autotrader + +> [WARNING]: There are still many bugs to be fixed, this software is not ready to be used for live trading. PRs and bug fixes welcome! + Autotrader is a forex quantitative trading engine I developed in two weeks using Go. The unique backtesting simulations runs a user-designed trading algorithm against historical market data. The simulation accounts for brokerage fees, hedging, leverage, market orders, limit orders, stop orders, and more. Once a reliable strategy has been identified, the user can run the trading algorithm they created on their live brokerage account. Autotrader inserts layers of abstraction all the way down from the implementation of the trading strategy to the orders and positions maintained by the brokers over their JSON REST APIs. All financial algorithms and data structures used in this project were developed from scratch, including a time series table inspired by the NumPy Python data science library. The following page is a report generated by Autotrader when backtesting a naive SMA crossover strategy using realtime Forex market data: -![https://raw.githubusercontent.com/lukewilson2002/autotrader/refs/heads/main/images/livetrades-example.jpeg](Graph of live trades as executed by the strategy.) +![Graph of live trades as executed by the strategy.](images/livetrades-example.jpeg) -![https://raw.githubusercontent.com/lukewilson2002/autotrader/refs/heads/main/images/profit-example.jpeg](Return on investment of the strategy plotted over time.) +![Return on investment of the strategy plotted over time.](images/profit-example.jpeg) -![https://raw.githubusercontent.com/lukewilson2002/autotrader/refs/heads/main/images/profitability-example.jpeg](Profitability graph of the strategy.) +![Profitability graph of the strategy.](images/profitability-example.jpeg) + +## How to use + +See the cmd/ directory for example trading strategies using this library. ## License