From ef1fdb5f369856fd901bf18aae81fa774f37dabe Mon Sep 17 00:00:00 2001
From: annieversary <annnnnie@protonmail.com>
Date: Sat, 24 Jul 2021 15:10:56 +0200
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2825b01
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# tootre
+
+thingy to do a regex search through your own toots
+
+it's slow, but it kinda works so meh. i just wanna use it to make sure i don't repeat a shitpost
+
+also the output is kinda ugly, i could improve it but meh
+
+## usage
+
+```
+tootre 0.1
+annieversary
+grep through own toots
+
+USAGE:
+    tootre [FLAGS] [OPTIONS] --regex <REGEX>
+
+FLAGS:
+    -b, --boosts     Includes boosts in the search
+    -h, --help       Prints help information
+    -v, --verbose    Sets the level of verbosity
+    -V, --version    Prints version information
+
+OPTIONS:
+    -m, --max <MAX>        Max number of toots to find
+    -r, --regex <REGEX>    Regex to use for matching toots
+```
+
+## building
+
+you will need rust and cargo and all that stuff
+
+run `cargo b --release` to build, then you can run with `target/release/tootre -r "meow"`