add docs

1 files changed, 6 insertions, 0 deletions

diff --git a/internal/flamegraph/nativesvg.go b/internal/flamegraph/nativesvg.go
index 831ffed..89a3e6b 100644
--- a/internal/flamegraph/nativesvg.go
+++ b/internal/flamegraph/nativesvg.go
@@ -8,6 +8,12 @@ import (
 	"strings"
 )
 
+// NativeSVG generates interactive flamegraph SVGs directly from .ior.zst data files.
+//
+// Flamegraphs are generated natively by ior from .ior.zst data files; no external
+// flamegraph tool is required. The CLI typically drives this via the -ior flag,
+// which reads trace data, aggregates it into a trie of stack frames (e.g. pid,path,tracepoint)
+// and renders a self-contained SVG that can be viewed in a browser.
 type NativeSVG struct {
 	fields     []string
 	countField string