docs: Update README.md to include new trading system details

[entelligence-ai-pr-reviews]

• Added Trading System Overview: Introduced a new section detailing the trading system components.

• New Classes:

  • Stock: Represents a stock with methods for price updates and history.
  • Portfolio: Manages user assets, including buying/selling stocks.
  • TradingSystem: Oversees trading operations, stock management, and portfolio state.

• New Methods:

  • Stock.update_price(new_price: float): Updates stock price and history.
  • Portfolio.buy(stock: Stock, quantity: int) -> bool: Executes stock purchases.
  • Portfolio.sell(stock: Stock, quantity: int) -> bool: Executes stock sales.
  • TradingSystem.add_stock(symbol: str, initial_price: float): Adds stocks to the system.
  • TradingSystem.start_trading(initial_balance: float): Initializes trading with a balance.
  • TradingSystem.simulate_market_movement(): Simulates market price changes.
  • TradingSystem.execute_trade(symbol: str, quantity: int, is_buy: bool) -> bool: Executes trades.
  • TradingSystem.get_portfolio_value() -> float: Calculates total portfolio value.
  • TradingSystem.save_portfolio_state(filename: str): Saves portfolio state to a file.

• Example Usage: Provided a code snippet demonstrating the trading system's functionality.

---

EntelligenceAI PR Summary

This PR updates the README to document the new trading system.

• Added sections for Stock, Portfolio, and TradingSystem classes with method overviews
• Included example usage instructions
• Applied minor formatting fixes (newline at end of file)

[greptile-apps]

PR Summary

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here: https://app.greptile.com/review/github.

_{💡 (4/5) You can add custom instructions or style guidelines for the bot here!}

_{1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile}

[entelligence-ai-pr-reviews]

Walkthrough

This update enhances project documentation by adding comprehensive details about a newly introduced trading system. The README now describes the core classes—Stock, Portfolio, and TradingSystem—outlining their main methods and responsibilities. An example usage section demonstrates how to initialize and interact with the system. Minor formatting improvements, such as correcting a missing newline, were also made to ensure consistency.

Changes

File(s)	Summary
README.md	Added documentation for the new trading system, including descriptions of Stock, Portfolio, and TradingSystem classes, their methods, and responsibilities. Included an example usage section and made minor formatting corrections (e.g., fixed missing newline).

Sequence Diagram

This diagram shows the interactions between components:

sequenceDiagram
    title Trading System Interactions
    
    actor User
    participant TradingSystem
    participant Stock
    participant Portfolio
    
    %% Initialization
    User->>TradingSystem: Create TradingSystem()
    User->>TradingSystem: add_stock("AAPL", 150.0)
    TradingSystem->>Stock: Create Stock("AAPL", 150.0)
    User->>TradingSystem: add_stock("GOOGL", 2800.0)
    TradingSystem->>Stock: Create Stock("GOOGL", 2800.0)
    User->>TradingSystem: add_stock("MSFT", 300.0)
    TradingSystem->>Stock: Create Stock("MSFT", 300.0)
    
    %% Start Trading
    User->>TradingSystem: start_trading(10000.0)
    TradingSystem->>Portfolio: Create Portfolio(10000.0)
    
    %% Trading Loop
    rect rgb(240, 240, 240)
        Note over User,TradingSystem: Trading Simulation Loop
        loop 5 times
            User->>TradingSystem: simulate_market_movement()
            TradingSystem->>Stock: update_price(new_price)
            Note over TradingSystem,Stock: Updates prices for all stocks
            
            %% Buy AAPL
            User->>TradingSystem: execute_trade("AAPL", 2, True)
            TradingSystem->>Portfolio: buy(stock, 2)
            alt Sufficient balance
                Portfolio-->>TradingSystem: true (purchase successful)
                Note over Portfolio: Updates balance and holdings
            else Insufficient balance
                Portfolio-->>TradingSystem: false (purchase failed)
            end
            TradingSystem-->>User: Trade result
            
            %% Buy GOOGL
            User->>TradingSystem: execute_trade("GOOGL", 1, True)
            TradingSystem->>Portfolio: buy(stock, 1)
            alt Sufficient balance
                Portfolio-->>TradingSystem: true (purchase successful)
                Note over Portfolio: Updates balance and holdings
            else Insufficient balance
                Portfolio-->>TradingSystem: false (purchase failed)
            end
            TradingSystem-->>User: Trade result
            
            %% Buy MSFT
            User->>TradingSystem: execute_trade("MSFT", 3, True)
            TradingSystem->>Portfolio: buy(stock, 3)
            alt Sufficient balance
                Portfolio-->>TradingSystem: true (purchase successful)
                Note over Portfolio: Updates balance and holdings
            else Insufficient balance
                Portfolio-->>TradingSystem: false (purchase failed)
            end
            TradingSystem-->>User: Trade result
        end
    end
    
    %% Portfolio Valuation and Saving
    User->>TradingSystem: get_portfolio_value()
    TradingSystem->>Portfolio: Calculate total value (cash + holdings)
    Portfolio-->>TradingSystem: Portfolio value
    TradingSystem-->>User: Final portfolio value
    
    User->>TradingSystem: save_portfolio_state("portfolio_state.json")
    TradingSystem->>Portfolio: Get portfolio data
    Portfolio-->>TradingSystem: Portfolio data
    Note over TradingSystem: Saves portfolio to JSON file

Loading

Details

▶️ ⚡ **AI Code Reviews for VS Code, Cursor, Windsurf** [Install the extension](https://marketplace.visualstudio.com/items?itemName=EntelligenceAI.EntelligenceAI-PR-Reviewer)

Note for Windsurf
Please change the default marketplace provider to the following in the windsurf settings:
Marketplace Extension Gallery Service URL: https://marketplace.visualstudio.com/_apis/public/gallery
Marketplace Gallery Item URL: https://marketplace.visualstudio.com/items

Entelligence.ai can learn from your feedback. Simply add 👍 / 👎 emojis to teach it your preferences. More shortcuts below

Emoji Descriptions:

• ⚠️ Potential Issue - May require further investigation.
• 🔒 Security Vulnerability - Fix to ensure system safety.
• 💻 Code Improvement - Suggestions to enhance code quality.
• 🔨 Refactor Suggestion - Recommendations for restructuring code.
• ℹ️ Others - General comments and information.

Interact with the Bot:

• Send a message or request using the format:
  @entelligenceai + *your message*

Example: @entelligenceai Can you suggest improvements for this code?

• Help the Bot learn by providing feedback on its responses.
  @entelligenceai + *feedback*

Example: @entelligenceai Do not comment on `save_auth` function !

Also you can trigger various commands with the bot by doing
@entelligenceai command

The current supported commands are

1. config - shows the current config
2. retrigger_review - retriggers the review

More commands to be added soon.

[entelligence-ai-pr-reviews]

LGTM 👍