Start copy from https://github.com/wcharczuk/go-chart

README.md

@@ -1,12 +1,96 @@
 go-chart
 ========
 
-This project is archived!
+This project starts from a full copy from [https://github.com/wcharczuk/go-chart](https://github.com/wcharczuk/go-chart). 28 Oct 2024.
 
-I originally released this as a way to publish stock charts in slack bots. It was kind of fun at the time! I never anticipated that it would become heavily used, and as often happens with open source, I have a ton of time commitments elsewhere, and can't reasonbly devote enough time to this project to match the usage.
+-
 
-There have been a number of forks over time, I'd encourage you all to seek those out, or new charting libraries. 
+Master should now be on the v3.x codebase, which overhauls the api significantly. Per usual, see `examples` for more information.
 
-Best,
+# Installation
 
-- Will
+To install `chart` run the following:
+
+```bash
+> go get github.com/wcharczuk/go-chart/v2@latest
+```
+
+Most of the components are interchangeable so feel free to crib whatever you want.
+
+# Output Examples
+
+Spark Lines:
+
+![](https://raw.githubusercontent.com/wcharczuk/go-chart/master/_images/tvix_ltm.png)
+
+Single axis:
+
+![](https://raw.githubusercontent.com/wcharczuk/go-chart/master/_images/goog_ltm.png)
+
+Two axis:
+
+![](https://raw.githubusercontent.com/wcharczuk/go-chart/master/_images/two_axis.png)
+
+# Other Chart Types
+
+Pie Chart:
+
+![](https://raw.githubusercontent.com/wcharczuk/go-chart/master/_images/pie_chart.png)
+
+The code for this chart can be found in `examples/pie_chart/main.go`.
+
+Stacked Bar:
+
+![](https://raw.githubusercontent.com/wcharczuk/go-chart/master/_images/stacked_bar.png)
+
+The code for this chart can be found in `examples/stacked_bar/main.go`.
+
+# Code Examples
+
+Actual chart configurations and examples can be found in the `./examples/` directory. They are simple CLI programs that write to `output.png` (they are also updated with `go generate`.
+
+# Usage
+
+Everything starts with the `chart.Chart` object. The bare minimum to draw a chart would be the following:
+
+```golang
+
+import (
+    ...
+    "bytes"
+    ...
+    "github.com/wcharczuk/go-chart/v2" //exposes "chart"
+)
+
+graph := chart.Chart{
+    Series: []chart.Series{
+        chart.ContinuousSeries{
+            XValues: []float64{1.0, 2.0, 3.0, 4.0},
+            YValues: []float64{1.0, 2.0, 3.0, 4.0},
+        },
+    },
+}
+
+buffer := bytes.NewBuffer([]byte{})
+err := graph.Render(chart.PNG, buffer)
+```
+
+Explanation of the above: A `chart` can have many `Series`, a `Series` is a collection of things that need to be drawn according to the X range and the Y range(s).
+
+Here, we have a single series with x range values as float64s, rendered to a PNG. Note; we can pass any type of `io.Writer` into `Render(...)`, meaning that we can render the chart to a file or a resonse or anything else that implements `io.Writer`.
+
+# API Overview
+
+Everything on the `chart.Chart` object has defaults that can be overriden. Whenever a developer sets a property on the chart object, it is to be assumed that value will be used instead of the default.
+
+The best way to see the api in action is to look at the examples in the `./_examples/` directory.
+
+# Design Philosophy
+
+I wanted to make a charting library that used only native golang, that could be stood up on a server (i.e. it had built in fonts).
+
+The goal with the API itself is to have the "zero value be useful", and to require the user to not code more than they absolutely needed.
+
+# Contributions
+
+Contributions are welcome though this library is in a holding pattern for the forseable future.