From 64d3e78262c35857ae9310c9b9da9ee91ea43dd2 Mon Sep 17 00:00:00 2001
From: ame <amelia@amyy.cc>
Date: Tue, 19 Dec 2023 11:38:17 -0600
Subject: some docs:3

---
 docs/io.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 docs/io.md

(limited to 'docs/io.md')

diff --git a/docs/io.md b/docs/io.md
new file mode 100644
index 0000000..d009c8d
--- /dev/null
+++ b/docs/io.md
@@ -0,0 +1,43 @@
+# io 
+
+## common 
+
+### pprint
+
+'accepts (probably) anything
+
+formats input as a readable string
+
+```lua
+llib.io.pprint({a = 5, b = {9, 9, 22}})
+```
+
+#### config options
+
+- print_type (0) - whether or not to print item type (0 or 1)
+- max_depth (2) - maximum depth that will not be collapsed
+- start_nl_at (3) - maximum depth that will be kept in-line
+
+### error/warn/log/debug 
+
+'accepts a string 
+
+outputs a fancy string (color!!!!)
+
+```lua
+llib.io.log("meow")
+```
+
+### readfile 
+
+'accepts a file path
+
+returns the content of that file as a string 
+
+```lua
+llib.io.readfile("./docs/io.md") -- (this file)
+```
+#### config options 
+
+- file_chunksize (512) - size of chunk to be allocated
+
-- 
cgit v1.2.3