Skip to content

docs: sync README.md and README.zh-CN.md with platform upgrade#7

Merged
rogerdigital merged 1 commit intomainfrom
docs/update-readme
Apr 14, 2026
Merged

docs: sync README.md and README.zh-CN.md with platform upgrade#7
rogerdigital merged 1 commit intomainfrom
docs/update-readme

Conversation

@rogerdigital
Copy link
Copy Markdown
Owner

Summary

  • Sync both README files to reflect all capabilities shipped in the platform upgrade
  • Architecture sections updated: charts/hooks paths, Hono/auth/SSE module paths, SQLite adapter, backtest engine path, VaR/CVaR calculators
  • Key Capabilities: added Charts & Market Data, Real-Time Push, Auth & Security sections; expanded existing sections
  • Quick Start: added env vars table (JWT_SECRET, BROKER_KEY_ENCRYPTION_KEY, DEMO credentials, USE_HONO)
  • Validation step list: inserted Lint (Biome) as step 5; total 12 → 13
  • Key Entry Points: added packages/trading-engine/src/backtest/index.ts

Test plan

  • No code changes — docs only
  • Verify rendered markdown looks correct on GitHub

Sync both README files to reflect the new capabilities shipped in the
platform upgrade: trading terminal, lightweight-charts components,
event-driven backtest engine, VaR/CVaR/Beta/HHI risk analytics,
SSE real-time push, JWT auth, AES-256-GCM broker key encryption,
Hono gateway layer, and SQLite WAL storage.

- Architecture sections: add charts/hooks paths, Hono/auth/SSE module
  paths, SQLite adapter note, and backtest engine path
- Key Capabilities: add Charts & Market Data, Real-Time Push, Auth &
  Security sections; expand Research, Execution, Risk, Agent, Ops
- Quick Start: add env vars table for JWT_SECRET, BROKER_KEY_ENCRYPTION_KEY,
  DEMO credentials, USE_HONO
- Validation: add Lint (Biome) as step 5; total steps 12 → 13
- Key Entry Points: add packages/trading-engine/src/backtest/index.ts
@rogerdigital rogerdigital merged commit fa77cb2 into main Apr 14, 2026
9 checks passed
@rogerdigital rogerdigital deleted the docs/update-readme branch April 14, 2026 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant