add readme

main
annieversary 2021-07-24 15:10:56 +02:00
parent 7d0a809bd6
commit ef1fdb5f36
1 changed files with 34 additions and 0 deletions

34
README.md Normal file
View File

@ -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"`