Add readme.md
This commit is contained in:
parent
8717f31a1b
commit
516c2529e2
8
README.md
Normal file
8
README.md
Normal 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)
|
Loading…
Reference in New Issue
Block a user