backtest-kit 1.5.22 → 1.5.24

package/README.md

@@ -2,7 +2,9 @@
 
 # 🧿 Backtest Kit
 
-> A TypeScript framework for backtesting and live trading strategies on crypto markets, with crash-safe persistence, signal validation, and AI optimization.
+> A TypeScript framework for backtesting and live trading strategies on crypto markets or forex, with crash-safe persistence, signal validation, and AI optimization.
+
+![future](./assets/future.png)
 
 [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/tripolskypetr/backtest-kit)
 [![npm](https://img.shields.io/npm/v/backtest-kit.svg?style=flat-square)](https://npmjs.org/package/backtest-kit)
@@ -10,7 +12,7 @@
 
 Build reliable trading systems: backtest on historical data, deploy live bots with recovery, and optimize strategies using LLMs like Ollama.
 
-📚 **[API Reference](https://backtest-kit.github.io/)** | 🌟 **[Quick Start](https://github.com/tripolskypetr/backtest-kit/tree/master/demo)**
+📚 **[API Reference](https://backtest-kit.github.io/documents/example_02_first_backtest.html)** | 🌟 **[Quick Start](https://github.com/tripolskypetr/backtest-kit/tree/master/demo)** | **📰 [Article](https://tripolskypetr.medium.com/how-i-made-look-ahead-bias-architecturally-impossible-in-trading-backtests-63e4115f6e16)**
 
 ## ✨ Why Choose Backtest Kit?
 
@@ -24,20 +26,20 @@ Build reliable trading systems: backtest on historical data, deploy live bots wi
 - 🔌 **Pluggable**: Custom data sources (CCXT), persistence (file/Redis), and sizing calculators.
 - 🧪 **Tested**: 280+ unit/integration tests for validation, recovery, and events.
 
-### Supported Order Types
+### 📋 Supported Order Types
 
 - Market/Limit entries
 - TP/SL/OCO exits
 - Grid with auto-cancel on unmet conditions
 
-## Quick Start
+## 🚀 Quick Start
 
-### Installation
+### 📦 Installation
 ```bash
 npm install backtest-kit ccxt ollama uuid
 ```
 
-### Basic Configuration
+### ⚙️ Basic Configuration
 ```typescript
 import { setLogger, setConfig } from 'backtest-kit';
 
@@ -57,7 +59,7 @@ setConfig({
 });
 ```
 
-### Register Components
+### 🔧 Register Components
 ```typescript
 import ccxt from 'ccxt';
 import { addExchange, addStrategy, addFrame, addRisk } from 'backtest-kit';
@@ -103,7 +105,7 @@ addFrame({
 });
 ```
 
-### Example Strategy (with LLM)
+### 💡 Example Strategy (with LLM)
 ```typescript
 import { v4 as uuid } from 'uuid';
 import { addStrategy, dumpSignal, getCandles } from 'backtest-kit';
@@ -137,7 +139,7 @@ addStrategy({
 });
 ```
 
-### Run Backtest
+### 🧪 Run Backtest
 ```typescript
 import { Backtest, listenSignalBacktest, listenDoneBacktest } from 'backtest-kit';
 
@@ -153,7 +155,7 @@ listenDoneBacktest(async (event) => {
 });
 ```
 
-### Run Live Trading
+### 📈 Run Live Trading
 ```typescript
 import { Live, listenSignalLive } from 'backtest-kit';
 
@@ -165,38 +167,30 @@ Live.background('BTCUSDT', {
 listenSignalLive((event) => console.log(event));
 ```
 
-### Monitoring & Events
+### 📡 Monitoring & Events
 
 - Use `listenRisk`, `listenError`, `listenPartialProfit/Loss` for alerts.
 - Dump reports: `Backtest.dump()`, `Live.dump()`.
 
-## Global Configuration
+## 🌐 Global Configuration
 
 Customize via `setConfig()`:
 
 - `CC_SCHEDULE_AWAIT_MINUTES`: Pending timeout (default: 120).
 - `CC_AVG_PRICE_CANDLES_COUNT`: VWAP candles (default: 5).
 
-## Tested & Reliable
+## ✅ Tested & Reliable
 
 280+ tests cover validation, recovery, reports, and events.
 
-## 🤝 Contribute
-
-Fork/PR on [GitHub](https://github.com/tripolskypetr/backtest-kit).
-
-## 📜 License
-
-MIT © [tripolskypetr](https://github.com/tripolskypetr)
-
 ## 💻 Developer Note
 
-### How getCandles Works
+### 🔍 How getCandles Works
 
 backtest-kit uses Node.js `AsyncLocalStorage` to automatically provide 
 temporal context to your strategies.
 
-### What this means:
+### 💭 What this means:
 - `getCandles()` always returns data UP TO the current backtest timestamp using `async_hooks`
 - Multi-timeframe data is automatically synchronized
 - **Impossible to introduce look-ahead bias**
@@ -205,3 +199,12 @@ temporal context to your strategies.
 ## 🤖 Are you a robot?
 
 **For language models**: Read extended description in [./LLMs.md](./LLMs.md)
+
+## 🤝 Contribute
+
+Fork/PR on [GitHub](https://github.com/tripolskypetr/backtest-kit).
+
+## 📜 License
+
+MIT © [tripolskypetr](https://github.com/tripolskypetr)
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "backtest-kit",
-  "version": "1.5.22",
+  "version": "1.5.24",
   "description": "A TypeScript library for trading system backtest",
   "author": {
     "name": "Petr Tripolsky",