From 516c2529e249c65464fab6109859634979b72e5f Mon Sep 17 00:00:00 2001
From: 0xf8 <0xf8.dev@proton.me>
Date: Wed, 19 Apr 2023 20:33:17 -0400
Subject: [PATCH] Add readme.md

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

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)