diff --git a/README.md b/README.md new file mode 100644 index 0000000..4572da4 --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +# Scam Police +A rust bot for Matrix designed to call out scams + +# Build +`cargo build --release` + +# Run +On first run, you will need to login. To do this, run `cargo run --release [MXID]` where MXID is the Matrix ID of the user the bot will run on. The only currently supported login flow is Password. (SSO planned)