Skip to content

docs: add usage examples to README#45

Merged
warren618 merged 1 commit into
HKUDS:mainfrom
hamza-mobeen:docs/usage-examples
Apr 20, 2026
Merged

docs: add usage examples to README#45
warren618 merged 1 commit into
HKUDS:mainfrom
hamza-mobeen:docs/usage-examples

Conversation

@hamza-mobeen

@hamza-mobeen hamza-mobeen commented Apr 19, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Adds a ## 💡 Examples section to README.md with concrete, real-world usage scenarios for new users.

  • Strategy & Backtesting — MA crossover, RSI mean-reversion, multi-factor on CSI 300, export to TradingView/TDX/MT5
  • Market Research — equity deep-dive, macro analysis, crypto on-chain
  • Swarm Workflows — 4 preset runs with real topics
    (investment_committee, quant_strategy_desk, crypto_trading_desk, macro_rates_fx_desk)
  • Cross-Session Memory — save preferences, auto-recall across sessions
  • Upload & Analyze Documents — broker CSV profiling, PDF earnings analysis

Section placed between CLI Reference and API Server.

@warren618 warren618 mentioned this pull request Apr 20, 2026
Closed
@warren618
warren618 merged commit 91ca793 into HKUDS:main Apr 20, 2026
warren618 added a commit that referenced this pull request Apr 21, 2026
@warren618
docs: news entries for 0.1.5 follow-up patches across 5 READMEs
1fdb39a 
- 04-21: workspace boundary fix (#43) + README usage examples (#45)
- 04-20: reasoning_content preservation (#39) + swarm streaming (#42)
- 04-18 / 04-17 entries pushed into <details> (top-3 visible convention)
longmfe pushed a commit to longmfe/Vibe-Trading-Mars that referenced this pull request Jul 14, 2026
@hamza-mobeen
docs: add usage examples to README (HKUDS#45)
f9022a3
longmfe pushed a commit to longmfe/Vibe-Trading-Mars that referenced this pull request Jul 14, 2026
@warren618
docs: news entries for 0.1.5 follow-up patches across 5 READMEs
b76af14 
- 04-21: workspace boundary fix (HKUDS#43) + README usage examples (HKUDS#45)
- 04-20: reasoning_content preservation (HKUDS#39) + swarm streaming (HKUDS#42)
- 04-18 / 04-17 entries pushed into <details> (top-3 visible convention)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@hamza-mobeen @warren618