velo-plot 2.20.0 → 3.1.0

package/README.md

@@ -1,4 +1,4 @@
-# Sci Plot 🚀
+# Velo Plot 🚀
 
 A high-performance, WebGL-powered scientific charting engine built for precision, speed, and deep interactivity. Optimized for electrochemical and scientific data visualization.
 
@@ -8,6 +8,10 @@ A high-performance, WebGL-powered scientific charting engine built for precision
 
 ## ✨ Features
 
+::: tip v3 bundle entries
+The default import (`velo-plot`) is the **core** bundle (~51 KB gzip): line, scatter, step, band, and area charts. Candlesticks, heatmaps, analysis, and trading APIs require `velo-plot/trading`, `velo-plot/scientific`, or `velo-plot/full`. See [Bundle Architecture](docs/guide/bundle-architecture.md).
+:::
+
 -   **🚀 High Performance**: Render millions of data points at 60 FPS using a specialized raw WebGL renderer.
 -   **📈 Advanced Analysis**: Built-in peak detection, integration, baseline correction, and customizable curve fitting (linear/poly/exp).
 -   **📊 Specialized Series**: Support for Lines, Scatter (SDF symbols), Step charts, Band series, Area charts, **Candlesticks** (OHLC), and **Stacked Charts**.
@@ -52,7 +56,7 @@ pnpm docs:dev
 ### React (Recommended)
 
 ```tsx
-import { SciPlot } from 'velo-plot/react';
+import { VeloPlot } from 'velo-plot/react';
 
 function App() {
   const data = {
@@ -62,7 +66,7 @@ function App() {
 
   return (
     <div style={{ width: '800px', height: '400px' }}>
-      <SciPlot 
+      <VeloPlot 
         series={[{ id: 's1', ...data, color: '#00f2ff' }]}
         xAxis={{ label: 'Time (s)' }}
         yAxis={{ label: 'Voltage (V)' }}
@@ -127,25 +131,35 @@ for (let i = 0; i < 20; i++) {
 
 ## 📖 Documentation
 
-Visit [Sci Plot Docs](https://jigonzalez930209.github.io/velo-plot/) for:
+Visit [Velo Plot Docs](https://jigonzalez930209.github.io/velo-plot/) for:
+-   [Bundle Architecture](https://jigonzalez930209.github.io/velo-plot/guide/bundle-architecture) — **start here for v3 imports**
 -   [Getting Started Guide](https://jigonzalez930209.github.io/velo-plot/guide/)
 -   [Core Concepts](https://jigonzalez930209.github.io/velo-plot/guide/concepts)
 -   [API Reference](https://jigonzalez930209.github.io/velo-plot/api/chart)
 -   [Interactive Examples](https://jigonzalez930209.github.io/velo-plot/examples/)
--   [Development Roadmap → v3.0.0](https://jigonzalez930209.github.io/velo-plot/roadmap/) — staged plan for trading + scientific features
+-   [Development Roadmap](https://jigonzalez930209.github.io/velo-plot/roadmap/)
 
 ## 🗺️ Development Roadmap
 
-The library is at **v1.12.0**. The active roadmap toward **v3.0.0** lives in [`docs/roadmap/`](./docs/roadmap/README.md) (6 stages: foundation audit, render engine, trading, scientific depth, React DX, stable release). Plugin audit: [`docs/PLUGIN-STATUS.md`](./docs/PLUGIN-STATUS.md). The older roadmap is archived at [`docs/ROADMAP-LEGACY.md`](./docs/ROADMAP-LEGACY.md).
+The library is at **v3.0.0**. Roadmap: [`docs/roadmap/`](./docs/roadmap/README.md). Plugin audit: [`docs/PLUGIN-STATUS.md`](./docs/PLUGIN-STATUS.md). Migration: [v1→v2](./docs/guide/migration-v2.md), [v2→v3](./docs/guide/migration-v3.md). **Bundles:** [Architecture](./docs/guide/bundle-architecture.md).
 
 ### Bundle entry points
 
-| Import | Contents |
-|--------|----------|
-| `velo-plot` | Core chart engine (~60KB) |
-| `velo-plot/full` | Everything including plugins, 3D, analysis |
-| `velo-plot/react` | `SciPlot`, `useSciPlot`, `useStackedPlot` |
-| `velo-plot/plugins/*` | Individual plugins (tree-shakeable) |
+| Import | Gzip (approx.) | Contents |
+|--------|----------------|----------|
+| `velo-plot` | ~51 KB | Core: line, scatter, step, band, plugins API |
+| `velo-plot/trading` | ~72 KB | + candles, indicators, stacked, alerts, WebGPU |
+| `velo-plot/scientific` | ~114 KB | + heatmap, bar, polar, analysis, 3D, LaTeX |
+| `velo-plot/full` | heavier | Everything |
+| `velo-plot/react` | — | `VeloPlot`, `StackedPlot`, hooks |
+| `velo-plot/vue` | — | `VeloPlot`, composables |
+| `velo-plot/svelte` | — | hooks + Svelte components |
+| `velo-plot/solid` | — | `VeloPlot`, hooks |
+| `velo-plot/angular` | — | components + services |
+| `velo-plot/astro` | — | island wrappers |
+| `velo-plot/plugins/*` | varies | Individual plugins (tree-shakeable) |
+
+Full guide: [Bundle Architecture](https://jigonzalez930209.github.io/velo-plot/guide/bundle-architecture)
 
 ## 📄 License