From dcb55e1f3ab75f8b96ad2fba9aa237c464462979 Mon Sep 17 00:00:00 2001 From: Yeon Lee Date: Sat, 7 Dec 2024 17:09:27 -0500 Subject: [PATCH] updated readme final before release --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a0636c5..53fd9ee 100644 --- a/README.md +++ b/README.md @@ -83,9 +83,10 @@ This ensures that strategies with better recent performance have a greater influ **Features**: -- **trading_strategies_v1.py**: First iteration of AmpyFin used 5 strategies. This file is not supported anymore but is a great reference material -- **trading_strategies_v2.py**: Houses most of the older strategies being used in the ranking system. Contains 50 strategies with a lot leaning towards momentum. -- **trading_strategies_v2_1.py**: Newer version that complements the older strategies. Houses 10 more strategies. This is where newer strategies will be implemented until it caps at 50 strategies as well. +- **trading_strategies_v1.py**: Archived first iteration of AmpyFin used 5 strategies. This file is not supported anymore but is a great reference material +- **trading_strategies_v2.py**: Archived second gen older strategies being used in the ranking system. Contains 50 strategies with a lot leaning towards momentum. +- **trading_strategies_v2_1.py**: Archived second gen older strategies that complements the older strategies in trading_strategies_v2.py. Houses 10 more strategies. This is where newer strategies will be implemented until it caps at 50 strategies as well. +- **talib_indicators.py**: Contains all the technical indicators used in the strategies. To visit the documentation for each technical indicator, please visit the following link: [Link to TA](https://ta-lib.org/). These indicators were not developed by me, but I have modified their use to fit the needs of AmpyFin. ### 🔧 helper_files/* @@ -113,8 +114,8 @@ pip install -r requirements.txt ``` - We have recently migrated to using Ta-Lib for trading. Please follow the installation instructions here: -👉 [Ta-Lib Python](https://github.com/TA-Lib/ta-lib-python) - +👉 [Ta-Lib Python Original](https://github.com/TA-Lib/ta-lib-python) +👉 [Ta-Lib Python Easy Installation](https://github.com/cgohlke/talib-build/releases) ### 3️⃣ Configuration @@ -164,7 +165,7 @@ python trading_client.py ## ⚠️ IMPORTANT -For people looking to do live trading, I suggest training via running ranking_client.py for about two weeks before running the trading bot altogether. This way, you're running with a client that has been trained to a certain extent (with strategies ranked) and is ready to go. Otherwise, you will most likely be buying random stocks. +For people looking to do live trading, I suggest training via running ranking_client.py for at least two weeks before running the trading bot altogether. This way, you're running with a client that has been trained to a certain extent (with strategies ranked) and is ready to go. Otherwise, you will most likely be buying random stocks. ## 📑 Logging