summaryrefslogtreecommitdiff
path: root/vendor/codeberg.org/gruf/go-kv/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/codeberg.org/gruf/go-kv/README.md')
-rw-r--r--vendor/codeberg.org/gruf/go-kv/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/vendor/codeberg.org/gruf/go-kv/README.md b/vendor/codeberg.org/gruf/go-kv/README.md
new file mode 100644
index 000000000..fa4735868
--- /dev/null
+++ b/vendor/codeberg.org/gruf/go-kv/README.md
@@ -0,0 +1,9 @@
+# go-kv
+
+This library provides a key-value field structure `kv.Field{}` that plays well with the `"fmt"` package. It gives an easy means of appending key-value fields to log entries, in a manner that also happens to look nice! (it's not far removed from using a `map[string]interface{}`).
+
+The formatting for these key-value fields is handled by the `"fmt"` package by default. If you set the `kvformat` build tag then it will use a custom formatting library found under `format/`. You can see the benchmarks for both below.
+
+![benchmarks](https://codeberg.org/gruf/go-kv/raw/main/benchmark.png)
+
+TODO: benchmarks comparing these to using `fmt.Sprintf("%q=%+v", ...)` yourself. \ No newline at end of file