Add readme.md

This commit is contained in:
0xf8 2023-04-19 20:33:17 -04:00
parent 8717f31a1b
commit 516c2529e2
Signed by: 0xf8
GPG Key ID: 446580D758689584

8
README.md Normal file
View File

@ -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)