From 1169154a145ff33b40ce74f9159484ef085da898 Mon Sep 17 00:00:00 2001
From: Ben Winston
Date: Sun, 5 May 2024 19:17:10 -0400
Subject: readme

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8d364c2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# booki
+
+but in C, 'cause why not?
+
+Things that work:
+ - [ ] `search` with arbitrary query items
+ - [ ] multiple `search` query items
+ - [ ] `--show` to print out most attributes
+
+Things that don't work:
+ - [ ] `search` with more than 5 query items
+ - [ ] searching for a single author in a multi-author item
+ - [ ] printing any array thing
+ - [ ] `^` or `$` in string searching
+
+Things that might change:
+ - [ ] `--show` might want to limit by field
+ - [ ] currently uses [tomlc99](https://github.com/cktan/tomlc99), which is great but might be overkill for this
+ - [ ] maybe prefixed `<` or `>` for numeric searches
+ - [ ] format strings
-- 
cgit v1.2.3