Initial commit

[squeep-logger-json-console] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..fc837ae
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# @squeep/logger
+
+A simple logger class, which mostly just structures messages, data, and some metadata as JSON and spews it, by default, to Console.
+
+Supports basic scrubbing of well-defined sensitive data, and an extensible set of JSON replacer functions for common objects.
+
+Intended to be specific to Squeep Framework Applications, this module has opinions.
+
+## API
+
+Expects these fields in any log call:
+
+- `scope` - file:method
+- `message` - text
+- `data` - object
+- any additional parameters are included as an array, but not scrubbed