aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
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