@chartts/core 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,82 @@
+# @chartts/core
+
+Beautiful charts. Tiny bundle. Every framework.
+
+SVG-first charting library with Tailwind support, under 15kb gzipped. 27 chart types with a flat, declarative API.
+
+## Install
+
+```bash
+npm install @chartts/core
+```
+
+## Quick start
+
+```ts
+import { createChart, lineChartType } from "@chartts/core"
+
+const chart = createChart(lineChartType, {
+  data: {
+    labels: ["Jan", "Feb", "Mar", "Apr", "May", "Jun"],
+    series: [{ name: "Revenue", values: [4200, 5800, 7100, 6400, 8200, 9600] }]
+  },
+  width: 600,
+  height: 300,
+})
+
+document.getElementById("chart").innerHTML = chart.toSVG()
+```
+
+## Server-side rendering
+
+```ts
+import { renderToString, lineChartType } from "@chartts/core"
+
+const svg = renderToString(lineChartType, data, { width: 600, height: 300 })
+// Returns an SVG string you can embed anywhere
+```
+
+## Chart types
+
+Line, bar, area, pie, donut, scatter, bubble, radar, candlestick, waterfall, funnel, gauge, sparkline, heatmap, treemap, boxplot, histogram, polar, radial bar, lollipop, bullet, dumbbell, calendar, combo, sankey, stacked bar, horizontal bar.
+
+Tree-shakeable. Import only what you use:
+
+```ts
+import { lineChartType } from "@chartts/core/line"
+import { barChartType } from "@chartts/core/bar"
+```
+
+## Tailwind integration
+
+Charts render as real SVG DOM elements. Style with CSS variables:
+
+```css
+:root {
+  --chartts-grid: rgba(0 0 0 / 0.06);
+  --chartts-axis: rgba(0 0 0 / 0.15);
+  --chartts-text-muted: #64748b;
+  --chartts-bg: #ffffff;
+}
+```
+
+## Framework packages
+
+For React, Vue, Svelte, and Solid, use the dedicated packages:
+
+```bash
+npm install @chartts/react   # React
+npm install @chartts/vue     # Vue
+npm install @chartts/svelte  # Svelte
+npm install @chartts/solid   # Solid
+```
+
+## Links
+
+- [Documentation](https://chartts.com/docs)
+- [Examples](https://chartts.com/examples)
+- [GitHub](https://github.com/chartts/chartts)
+
+## License
+
+MIT