Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewbaronick committed Mar 5, 2024
1 parent 2a32154 commit c277a04
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
## 📜 Description
Elevate your trading strategies with BacktestJS, the premier CLI tool designed for traders and developers alike. Harness the power of Typescript or Javascript to backtest your strategies with precision, efficiency, and flexibility.


 
## 🌟 Key Features
- 🖥️ **Streamlined CLI Interface**: Intuitive command-line interface for streamlined operation.

Expand All @@ -25,7 +25,7 @@ Elevate your trading strategies with BacktestJS, the premier CLI tool designed f

- 📚 **Extensive Documentation**: Unlock the full potential of BacktestJS with detailed guides and resources.


 
## 🚀 Quick Start
### 📦 Setup Environment
Install BacktestJS globally with npm to get started:
Expand All @@ -41,15 +41,15 @@ Enter the world of strategic backtesting with a single command:
npm start
```


 
## 📖 [Documentation and Support](http://backtestjs.com)
Immerse yourself in the BacktestJS universe with our [Full Documentation](http://backtestjs.com). Discover tutorials, video guides, and extensive examples. Engage with our community forum for unparalleled support and discussions. Visit our site to unleash the full capabilities of BacktestJS.


 
## 🔄 Download / Import Historical Candle Data
Effortlessly download candle data from Binance or import from a CSV for strategy execution — no coding required! Plus, easily export your data to CSV via the CLI at anytime with a few clicks.


 
## 💡 Examples

#### **No Params**
Expand Down Expand Up @@ -106,7 +106,7 @@ export async function sma(bth: BTH) {
}
```
 
## 🎨 Showcase of Results
BacktestJS not only delivers performance insights but also visualizes your strategy's effectiveness through comprehensive charts and statistics.
Expand Down Expand Up @@ -140,7 +140,7 @@ Examine permutation results and heatmap visualizations to refine your strategies
![Total Stats](http://backtestjs.com/wp-content/uploads/2024/02/Trading-Strategy-Results-Multi-Value-Total-Stats.png)
## 🌍 Multi Symbol Results
### 🌍 Multi Symbol Results
See if that killer strategy works across the board on many symbols and timeframes with ease. Get all your results in one shot with blazing fast results.
![General Info](http://backtestjs.com/wp-content/uploads/2024/01/Multi-Symbol-Trading-Strategy-Results-General-Info.png)
Expand All @@ -149,7 +149,7 @@ See if that killer strategy works across the board on many symbols and timeframe
![Permutation Results](http://backtestjs.com/wp-content/uploads/2024/01/Multi-Symbol-Trading-Strategy-Results-Permutation-Results.png)
 
## ✍️ Author
#### Andrew Baronick
Expand Down

0 comments on commit c277a04

Please sign in to comment.