Skip to content

Commit 522798b

Browse files
committed
Update README
1 parent 4018c36 commit 522798b

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

README.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Thales: Options Trading Bot
1+
# Thales
22

3-
Thales is a high-frequency, algorithmic trading bot designed for trading options contracts, named after the Greek philosopher [Thales of Miletus](https://en.wikipedia.org/wiki/Thales_of_Miletus), who is credited with the first recorded use of an options contract.
3+
Thales is a high-frequency, algorithmic trading bot designed for options contracts, named after the Greek philosopher [Thales of Miletus](https://en.wikipedia.org/wiki/Thales_of_Miletus), who is credited with the first recorded use of an options contract.
44

55
## Features
66

@@ -19,13 +19,13 @@ Thales is a high-frequency, algorithmic trading bot designed for trading options
1919
- Boost libraries (for networking and datetime handling)
2020
- nlohmann/json (for configuration parsing)
2121

22-
## Building from Source
22+
## Build
2323

2424
### Linux/macOS
2525

2626
```bash
2727
# Clone the repository
28-
git clone https://github.com/yourusername/thales.git
28+
git clone https://github.com/cm-jones/thales.git
2929
cd thales
3030

3131
# Create a build directory
@@ -43,7 +43,7 @@ make
4343

4444
```bash
4545
# Clone the repository
46-
git clone https://github.com/yourusername/thales.git
46+
git clone https://github.com/cm-jones/thales.git
4747
cd thales
4848

4949
# Create a build directory
@@ -69,40 +69,40 @@ Thales is configured through a JSON file located in the `config` directory. The
6969
### Configuration Options
7070

7171
- **Engine**: General settings for the trading engine
72-
- `loopIntervalMs`: Main loop interval in milliseconds
73-
- `maxThreads`: Maximum number of threads to use
72+
- `loop_interval_ms`: Main loop interval in milliseconds
73+
- `max_threads`: Maximum number of threads to use
7474

7575
- **Risk**: Risk management settings
76-
- `maxPositionSize`: Maximum position size in dollars
77-
- `maxDrawdown`: Maximum allowed drawdown as a fraction of portfolio value
78-
- `maxLeverage`: Maximum allowed leverage
79-
- `maxRiskPerTrade`: Maximum risk per trade as a fraction of portfolio value
80-
- `maxDailyLoss`: Maximum allowed daily loss as a fraction of portfolio value
76+
- `max_position_size`: Maximum position size in dollars
77+
- `max_drawdown`: Maximum allowed drawdown as a fraction of portfolio value
78+
- `max_leverage`: Maximum allowed leverage
79+
- `max_risk_per_trade`: Maximum risk per trade as a fraction of portfolio value
80+
- `max_daily_loss`: Maximum allowed daily loss as a fraction of portfolio value
8181

8282
- **Data**: Market data settings
83-
- `ibHost`: Interactive Brokers TWS/Gateway host
84-
- `ibPort`: Interactive Brokers TWS/Gateway port
85-
- `ibClientId`: Interactive Brokers client ID
86-
- `ibAccount`: Interactive Brokers account ID
83+
- `ib_host`: Interactive Brokers TWS/Gateway host
84+
- `ib_port`: Interactive Brokers TWS/Gateway port
85+
- `ib_client_id`: Interactive Brokers client ID
86+
- `ib_account`: Interactive Brokers account ID
8787
- `symbols`: List of symbols to trade
88-
- `barSizes`: List of bar sizes to request
89-
- `historyDays`: Number of days of historical data to request
88+
- `bar_sizes`: List of bar sizes to request
89+
- `history_days`: Number of days of historical data to request
9090

9191
- **Strategies**: Trading strategy settings
9292
- `enabled`: List of enabled strategies
9393
- Strategy-specific settings
9494

9595
- **Logging**: Logging settings
96-
- `logToFile`: Whether to log to a file
97-
- `logFilePath`: Path to the log file
98-
- `consoleLogLevel`: Minimum log level for console output
99-
- `fileLogLevel`: Minimum log level for file output
96+
- `log_to_file`: Whether to log to a file
97+
- `log_file_path`: Path to the log file
98+
- `console_log_level`: Minimum log level for console output
99+
- `file_log_level`: Minimum log level for file output
100100

101101
- **Backtesting**: Backtesting settings
102102
- `enabled`: Whether to run in backtesting mode
103-
- `startDate`: Start date for backtesting
104-
- `endDate`: End date for backtesting
105-
- `initialCapital`: Initial capital for backtesting
103+
- `start_date`: Start date for backtesting
104+
- `end_date`: End date for backtesting
105+
- `initial_capital`: Initial capital for backtesting
106106
- `commission`: Commission rate for backtesting
107107
- `slippage`: Slippage rate for backtesting
108108

0 commit comments

Comments
 (0)