@alphacharts/core 0.0.0-stage → 0.1.0

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,26 @@
-# 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
+required.
+
+```
+npm install @alphacharts/core
+```
+
+```ts
+import { createChart } from "@alphacharts/core";
+
+const chart = createChart(el, { theme: "dark", timeZone: "UTC" });
+const candles = chart.addSeries("candles", { 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" });
+```
+
+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.