openalgo-charts 1.0.0 → 1.0.2

package/NOTICE

@@ -0,0 +1,15 @@
+OpenAlgo Charts
+Copyright 2026 OpenAlgo
+
+This product includes software developed as part of the OpenAlgo project.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+This is original, clean-room code with no third-party charting library
+dependencies. Should any third-party (Apache-2.0 or compatibly licensed)
+routine ever be incorporated, its copyright/license headers will be preserved
+and an attribution to its original authors will be added to this file.

package/README.md

@@ -1,80 +1,112 @@
+<div align="center">
+
 # OpenAlgo Charts
 
-A from-scratch, dependency-free HTML5-canvas charting engine for OpenAlgo:
-professional-grade interactive financial-chart rendering plus advanced on-chart
-trading and trade management. Target: **< 50 KB Brotli** for the full package.
+**A from-scratch, dependency-free HTML5-canvas charting engine for OpenAlgo.**
 
-## Documentation
+Professional interactive financial charts, on-chart trading, and live data - in under 40 KB Brotli, with zero runtime dependencies.
 
-Full docs, an interactive example gallery, and the API reference live at:
+[![npm version](https://img.shields.io/npm/v/openalgo-charts.svg?color=cb3837&label=npm)](https://www.npmjs.com/package/openalgo-charts)
+[![license](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE)
+[![bundle](https://img.shields.io/badge/brotli-~24%20KB%20base%20%C2%B7%20~38%20KB%20full-brightgreen.svg)](./ARCHITECTURE.md)
+[![tests](https://img.shields.io/badge/tests-297%20passing-brightgreen.svg)](#develop)
+[![dependencies](https://img.shields.io/badge/runtime%20deps-0-brightgreen.svg)](#principles)
 
-**https://marketcalls.github.io/openalgo-charts/**
+[**Documentation**](https://marketcalls.github.io/openalgo-charts/) &nbsp;·&nbsp; [**Live examples**](https://marketcalls.github.io/openalgo-charts/examples) &nbsp;·&nbsp; [**Getting started**](./docs/getting-started.md) &nbsp;·&nbsp; [**Architecture**](./ARCHITECTURE.md)
+
+<img src="docs/architecture-diagram.png" alt="OpenAlgo Charts - layered architecture from public API down to feeds and data, with loadable bundle tiers" width="920" />
+
+</div>
+
+---
+
+## Live OpenAlgo trading terminal
 
-The site is built with Nextra (in [`website/`](./website)) and statically exported to
-GitHub Pages on every push. Every code sample on a docs page is a *live* chart running the
-real library, so what you read is what runs. Adding a page is intentionally one step: drop a
-`.mdx` file in `website/pages/docs` and add one line to `website/pages/docs/_meta.ts`. To
-run the site locally:
+Right-click the chart to place market / limit / stop orders, drag the order and TP/SL bracket lines to modify, and watch live P&amp;L on the position line - all on real OpenAlgo history + WebSocket tick data, with an analyzer (sandbox) mode so nothing goes live until you arm it.
+
+<p align="center">
+  <img src="docs/trading.png" alt="OpenAlgo Charts live trading terminal: RELIANCE 5m candles with order lines, a right-click order menu, a long position with live P&L, and volume" width="920" />
+</p>
+
+## Examples gallery
+
+Every chart in the [live gallery](https://marketcalls.github.io/openalgo-charts/examples) is the real library running in your browser - switch tabs, hover the crosshair, drag the order lines. What you see is the code that ran.
+
+<p align="center">
+  <img src="docs/demo1.png" alt="Chart-type switcher, custom themes, data tooltips, and event markers" width="49%" />
+  <img src="docs/demo2.png" alt="Range switcher, legend, series compare, and indicators and markers" width="49%" />
+</p>
+<p align="center">
+  <img src="docs/demo3.png" alt="More live OpenAlgo Charts examples" width="49%" />
+  <img src="docs/demo4.png" alt="More live OpenAlgo Charts examples" width="49%" />
+</p>
+
+## Install
 
 ```bash
-npm run build                 # build the library (dist/) the live demos import
-cd website && npm install && npm run dev   # http://localhost:3000/openalgo-charts
+npm install openalgo-charts
 ```
 
-> Status: **pre-release (0.1.0)** — all 12 build phases of the engine are
-> implemented (standard chart types, transforms, trade terminal, depth ladder,
-> profiles) with 190+ unit tests, full package **~26 KB Brotli**. See
-> [`ARCHITECTURE.md`](./ARCHITECTURE.md), [`docs/getting-started.md`](./docs/getting-started.md),
-> and [`examples/index.html`](./examples/index.html).
->
-> **Known limitations (not yet production-complete):** the OpenAlgo WS/trade
-> adapters ship but their exact message/endpoint schemas must be verified against
-> your running OpenAlgo build; there is **no real-browser/pixel test suite yet**
-> (logic is covered by a recording-canvas harness); multi-touch pinch, separate
-> axis-widget canvases, and overlay/indexed-to-100 price scales are not
-> implemented. See [`END_TO_END_AUDIT.md`](./END_TO_END_AUDIT.md) for the full list.
+```ts
+import { createChart, generateBars } from 'openalgo-charts';
+
+const chart = createChart(document.getElementById('chart'));
+chart.addSeries('candlestick').setData(generateBars(1700000000, 200, 3600));
+```
+
+Loadable tiers - lazy-load only what you use:
+
+| Import | Contents |
+|---|---|
+| `openalgo-charts` | Base engine + all standard chart types, indicators, primitives, trading overlay |
+| `openalgo-charts/trade` | On-chart order/position/bracket tools + DOM ladder |
+| `openalgo-charts/transform` | Renko, Range bars, Point &amp; Figure, Kagi, Line Break, Heikin Ashi |
+| `openalgo-charts/profile` | Volume Profile, Market Profile (TPO), Footprint, Order flow |
 
 ## What's built
 
-- **Chart types:** candles, hollow/volume candles, bars, high-low, line,
-  line+markers, step, area, HLC-area, baseline, columns, histogram.
+- **Chart types:** candles, hollow/volume candles, bars, high-low, line, line+markers, step, area, HLC-area, baseline, columns, histogram.
 - **Transforms:** Heikin Ashi, Renko, Range bars, Line Break, Point &amp; Figure, Kagi.
 - **Profiles &amp; order flow:** Volume Profile, Market Profile (TPO), Footprint, cumulative delta.
-- **Trading:** order/position/bracket lines, live P&amp;L, one-click + drag-to-modify,
-  OCO, validation, analyzer mode, and a depth-of-market ladder (5→200 levels).
-- **Live + historical** data, markers/signals, earnings/dividend events, EMA indicator.
+- **Trading:** order/position/bracket lines, live P&amp;L, one-click + drag-to-modify, OCO, validation, analyzer mode, and a depth-of-market ladder (5 to 200 levels).
+- **Live + historical** OpenAlgo data (REST history + WebSocket ticks with auto-reconnect), a unified `chart.on(...)` event bus, markers/signals, earnings/dividend/expiry event markers, custom price/time formatters, and EMA/RSI/ATR/Supertrend indicators.
 
-## Install (once published)
+## Documentation
 
-```bash
-npm install openalgo-charts
-```
+Full docs, the interactive example gallery, and the generated API reference live at:
 
-Loadable tiers (lazy-load only what you use):
+**https://marketcalls.github.io/openalgo-charts/**
+
+The site is built with Nextra (in [`website/`](./website)) and statically exported to GitHub Pages on every push. Every code sample on a docs page is a *live* chart running the real library, so what you read is what runs. To run the site locally:
 
-- `openalgo-charts` — base engine + all standard chart types
-- `openalgo-charts/trade` — on-chart order/position/bracket tools + DOM ladder
-- `openalgo-charts/transform` — Renko, Range bars, Point & Figure, Kagi, Line Break, Heikin Ashi
-- `openalgo-charts/profile` — Volume Profile, Market Profile (TPO), Footprint, Orderflow
+```bash
+npm run build                               # build the library (dist/) the live demos import
+cd website && npm install && npm run dev    # http://localhost:3000/openalgo-charts
+```
 
 ## Develop
 
 ```bash
 npm install        # install dev toolchain
 npm run typecheck  # strict TypeScript check
-npm test           # unit tests (vitest)
-npm run build      # Rollup → dist/ (minified ESM per tier + types)
+npm test           # unit tests (vitest) - 297 across 39 files
+npm run build      # Rollup -> dist/ (minified ESM per tier + types)
 npm run size       # size-limit (Brotli) against the budget
-npm run verify     # all of the above
+npm run e2e        # Playwright Chromium smoke tests
+npm run verify     # typecheck + test + build + size
 ```
 
 ## Principles
 
-- **Single canvas pipeline** (no SVG, no DOM-per-bar) — small and fast.
-- **Gapless time axis by default** — weekends, holidays, and session breaks collapse.
-- **Zero runtime dependencies** — nothing is excluded from the size budget.
+- **Single canvas pipeline** (no SVG, no DOM-per-bar) - small and fast.
+- **Gapless time axis by default** - weekends, holidays, and session breaks collapse.
+- **Zero runtime dependencies** - nothing is excluded from the size budget.
 - **Apache-2.0**, original code.
 
+## Status &amp; limitations
+
+Version **1.0.1 (published)** - all engine build phases are implemented with 297 unit tests, base engine ~24 KB Brotli, full package ~38 KB Brotli (all tiers). The OpenAlgo WS/trade adapters ship and auto-reconnect, but their exact message/endpoint schemas should be verified against your running OpenAlgo build. Overlay and `indexed-to-100` price scales are not yet implemented - see [`ARCHITECTURE.md`](./ARCHITECTURE.md) for the honest deferred list.
+
 ## License
 
-[Apache-2.0](./LICENSE).
+[Apache-2.0](./LICENSE). See [`NOTICE`](./NOTICE).