some docs

ammario · ammario · commit cd77569d26c6 · 2023-05-09T12:51:34.000-05:00
diff --git a/internal/entryhuman/logfmt/README.md b/internal/entryhuman/logfmt/README.md
@@ -0,0 +1,25 @@
+# logfmt
+
+logfmt provides an implementation that supports nested objects and arrays. It
+is meant to be a drop-in replacement for JSON, which other logfmt implements
+do not support.
+
+This package makes the trade-off of being more difficult for computers to parse
+in favor of the human.
+
+See these examples:
+
+JSON:
+```json
+{ "user": { "id": 123, "name": "foo", "age": 20, "hobbies": ["basketball", "football"] } }
+```
+
+flat logfmt:
+```
+user.id=123 user.name=foo user.age=20 user.hobbies="basketball,football"
+```
+
+nested logfmt:
+```
+user={ id=123 name=foo age=20 hobbies=[basketball football] }
+```
