From aaa12b1e5c4f8be6f88d529aeb5ee517d016f305 Mon Sep 17 00:00:00 2001
From: tangent <rose@tangentfox.com>
Date: Wed, 16 Sep 2026 14:07:07 -0600
Subject: [PATCH] Add ReadMe.md

---
 ReadMe.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 ReadMe.md

diff --git a/ReadMe.md b/ReadMe.md
new file mode 100644
index 0000000..5c3fbec
--- /dev/null
+++ b/ReadMe.md
@@ -0,0 +1,18 @@
+# microlog
+A small very flexible logging library for Lua.
+
+## Usage
+```lua
+-- set arbitrary log levels to be printed immediately
+log{ info = true, warning = true, ducksauce = true, }
+-- send anything (except nil) to a log level
+log("bacom", true, "text", 5, function() end, {})
+-- print all messages saved at a particular log level
+log("error")
+-- toggle ALL logging on and off with a boolean
+log(false) -- this deletes all stored messages
+-- set a maximum number of stored messages per log level
+log(50) -- warning: reaching large limits makes logging expensive
+-- do anything to the stored messages (this example deletes them all)
+log(function(messages) return {} end)
+```