@alphacharts/core 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alphabench
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,41 @@
-# Temporary Holding Version
+# @alphacharts/core
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The alphacharts engine: WebGL2 series (candles, line, area, histogram, ...), Canvas2D text, panes, price and time
+scales, crosshair, markers, price lines, synced charts and a datafeed driver. No runtime dependencies. WebGL2 is
+used when available, with a Canvas2D fallback (`renderer: "auto" | "webgl" | "canvas2d"`).
+
+```
+npm install @alphacharts/core
+```
+
+```ts
+import { createChart } from "@alphacharts/core";
+
+const chart = createChart(el, { theme: "dark", timeZone: "UTC" });
+const candles = chart.addSeries("candles", { priceFormat: { type: "price", minMove: 0.05 } });
+candles.setData(bars);   // [{ time, open, high, low, close }], time in UTC ms
+candles.update(bar);     // live: same time replaces, later time appends
+chart.createPriceLine(candles, { price: 100, title: "target" });
+```
+
+Colour individual candles or bars, and shade a pane's background per bar:
+
+```ts
+candles.setBarColors({ time: Float64Array.of(t1, t2), color: Uint32Array.of(0xffd835ff, 0) }); // 0xRRGGBBAA, 0 = the up/down colours
+candles.clearBarColors();                                   // exactly as before, column and all
+candles.attachPrimitive(new BarShading());                   // .set(times, colors) / .setAt(time, color): behind the series, no part in autoscale
+```
+
+A bar's colour belongs to (series, time): `update`, `prepend` and `setData` keep the colours of the bars they keep, `OhlcBar.color` and
+`ColumnarOhlc.color` set them from the data. The colour column is added to the store, and to the level-of-detail pyramid (a bucket takes the last coloured
+bar's colour), the first time a colour is written; a series never coloured has no such column, and its candle and bar shaders do one
+integer compare per vertex on the colour slot every GPU record already carries (no added buffer). A value series' points
+may carry their own colour too (`ValuePoint.color`), which the line renderers draw per segment (the colour of the point the segment arrives at), in WebGL and Canvas2D.
+`DataChange.kind` has a new value, `"color"`, announced to renderers only: plugins such as studies are not told, because nothing they follow moved.
+
+Hide the Alphabench brand mark with `createChart(el, { watermark: { visible: false } })`.
+
+`@alphacharts/core/internal` exposes rendering internals for the sibling series packages (`chart-types`,
+`orderflow`). It is not public API and changes without notice.
+
+See the [repository README](https://github.com/alphabench/alphacharts#readme) for the full guide. MIT licence.