backtest-kit 1.5.24 → 1.5.25

package/README.md

@@ -25,8 +25,9 @@ Build reliable trading systems: backtest on historical data, deploy live bots wi
 - 🛡️ **Risk Management**: Custom rules for position limits, time windows, and multi-strategy coordination.
 - 🔌 **Pluggable**: Custom data sources (CCXT), persistence (file/Redis), and sizing calculators.
 - 🧪 **Tested**: 280+ unit/integration tests for validation, recovery, and events.
+- 🔓 **Self hosted**: Zero dependency on third-party node_modules or platforms; run entirely in your own environment.
 
-### 📋 Supported Order Types
+## 📋 Supported Order Types
 
 - Market/Limit entries
 - TP/SL/OCO exits
@@ -34,6 +35,8 @@ Build reliable trading systems: backtest on historical data, deploy live bots wi
 
 ## 🚀 Quick Start
 
+> Link to [the source code](https://github.com/tripolskypetr/backtest-kit/tree/master/demo)
+
 ### 📦 Installation
 ```bash
 npm install backtest-kit ccxt ollama uuid
@@ -179,16 +182,14 @@ Customize via `setConfig()`:
 - `CC_SCHEDULE_AWAIT_MINUTES`: Pending timeout (default: 120).
 - `CC_AVG_PRICE_CANDLES_COUNT`: VWAP candles (default: 5).
 
-## ✅ Tested & Reliable
-
-280+ tests cover validation, recovery, reports, and events.
-
 ## 💻 Developer Note
 
+Backtest Kit is **not a data-processing library** - it is a **time execution engine**. Think of the engine as an **async stream of time**, where your strategy is evaluated step by step.
+
 ### 🔍 How getCandles Works
 
 backtest-kit uses Node.js `AsyncLocalStorage` to automatically provide 
-temporal context to your strategies.
+temporal time context to your strategies.
 
 ### 💭 What this means:
 - `getCandles()` always returns data UP TO the current backtest timestamp using `async_hooks`
@@ -196,10 +197,53 @@ temporal context to your strategies.
 - **Impossible to introduce look-ahead bias**
 - Same code works in both backtest and live modes
 
+
+## 🧠 Two Ways to Run the Engine
+
+Backtest Kit exposes the same runtime in two equivalent forms. Both approaches use **the same engine and guarantees** - only the consumption model differs.
+
+### 1️⃣ Event-driven (background execution)
+
+Suitable for production bots, monitoring, and long-running processes.
+
+```typescript
+Backtest.background('BTCUSDT', config);
+
+listenSignalBacktest(event => { /* handle signals */ });
+listenDoneBacktest(event => { /* finalize / dump report */ });
+```
+
+### 2️⃣ Async Iterator (pull-based execution)
+
+Suitable for research, scripting, testing, and LLM agents.
+
+```typescript
+for await (const event of Backtest.run('BTCUSDT', config)) {
+  // signal | trade | progress | done
+}
+```
+
+## 🆚 Think of it as...
+
+**Open-source QuantConnect without the vendor lock-in**
+
+Unlike cloud-based platforms, backtest-kit runs entirely in your environment. You own the entire stack from data ingestion to live execution. In addition to Ollama, you can use [neural-trader](https://www.npmjs.com/package/neural-trader) in `getSignal` function or any other third party library
+
+- No C# required - pure TypeScript/JavaScript
+- Self-hosted - your code, your data, your infrastructure
+- No platform fees or hidden costs
+- Full control over execution and data sources
+- [GUI](https://backtest-kit.github.io/documents/design_30_markdown-report-system.html#method-signatures) for visualization and monitoring
+
+
 ## 🤖 Are you a robot?
 
 **For language models**: Read extended description in [./LLMs.md](./LLMs.md)
 
+## ✅ Tested & Reliable
+
+280+ tests cover validation, recovery, reports, and events.
+
 ## 🤝 Contribute
 
 Fork/PR on [GitHub](https://github.com/tripolskypetr/backtest-kit).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "backtest-kit",
-  "version": "1.5.24",
+  "version": "1.5.25",
   "description": "A TypeScript library for trading system backtest",
   "author": {
     "name": "Petr Tripolsky",
@@ -12,7 +12,7 @@
     "url": "http://paypal.me/tripolskypetr"
   },
   "license": "MIT",
-  "homepage": "https://backtest-kit.github.io/modules.html",
+  "homepage": "https://backtest-kit.github.io/documents/example_02_first_backtest.html",
   "keywords": [
     "backtesting",
     "backtest",