bamtigraph 0.1.0

package/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, GoSuda
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,97 @@
+# BamtiGraph
+
+Turn traffic, CPU, memory, and other measurements into clear time-series charts. Use BamtiGraph in a browser, from TypeScript, or from Go.
+
+## What you can do
+
+- Draw line and area charts from your own data.
+- Show daily, weekly, monthly, or yearly views.
+- Import CSV files and save charts as PNG images.
+- Choose your colors, labels, and time zone.
+- Keep charts unbranded or add your own text.
+
+## Try the demo
+
+From the project folder:
+
+```sh
+npm ci
+npm run build
+npm run serve
+```
+
+Open **http://127.0.0.1:8080**. You can change the chart settings, add a custom label, and export an image. The demo uses sample data, not live measurements.
+
+## Use TypeScript
+
+Install the npm package:
+
+```sh
+npm install bamtigraph
+```
+
+The Deno package name is `jsr:@safe/bantigraph`; JSR releases are published separately.
+
+This Node.js example creates a chart and saves it as `traffic.png`:
+
+```ts
+import { writeFile } from "node:fs/promises";
+import { traffic } from "bamtigraph";
+
+const chart = traffic(
+  [0, 300, 600],
+  [180e6, 195e6, 188e6],
+  [42e6, 45e6, 43e6],
+  {
+    title: "My network",
+    fonts: { mode: "bitmap" },
+  },
+);
+
+await writeFile("traffic.png", chart.toPNG());
+```
+
+Replace the arrays with your timestamps, incoming values, and outgoing values. Numeric timestamps are Unix seconds. Use `null` for a missing reading.
+
+For charts on a web page, follow the [browser integration guide](docs/index.html#typescript).
+
+## Use Go
+
+Try the included example from the project folder:
+
+```sh
+go run ./examples/quickstart -o traffic.png
+```
+
+To create a chart from a CSV file:
+
+```sh
+go run ./cmd/bamtigraph -input examples/traffic.csv -o traffic.png
+```
+
+The Go package is `github.com/gosuda/BamtiGraph`. See the [Go quickstart source](examples/quickstart/main.go) to use it in your application. If Go cannot find a suitable font, add `-font /path/to/font.ttf`.
+
+## Make it yours
+
+No watermark is drawn by default. To add your own text along the right edge:
+
+```ts
+const branded = chart.with({ watermark: "My network" });
+await writeFile("branded.png", branded.toPNG());
+```
+
+In Go, set `graph.Watermark = "My network"`, or pass `-watermark "My network"` to the command-line example. Use `BAMTIGRAPH` if you want the library name, or an empty string to remove the text.
+
+In the demo, use **Custom edge text**. You can also change the surrounding page labels in `assets/brand.js`.
+
+## Explore more
+
+- [Browser examples](docs/index.html#examples)
+- [TypeScript options and API](docs/API.md)
+- [Go usage guide](docs/index.html#go)
+- [Release setup](docs/index.html#publishing)
+- [Security notes](docs/SECURITY.md)
+
+## License
+
+BSD-3-Clause. See [LICENSE](LICENSE).