From 84db650610afc170c3e335accb3816a4fdc48092 Mon Sep 17 00:00:00 2001
From: spla <salvador.pla@mastodont.cat>
Date: Mon, 26 Jul 2021 15:53:48 +0200
Subject: [PATCH] Added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..681e1dc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Mastodon's spamcheck
+
+Check and store data from spam bots trying to register to your Mastodon server.
+You need to configure your Mastodon server like this:  
+  
+- Registration mode -> Approval required for sign up  
+- Require new users to enter a reason to join -> activated  
+
+### Dependencies
+
+-   **Python 3**
+-   Postgresql server
+-   [Mastodon](https://joinmastodon.org) server admin
+
+### Usage:
+
+Within Python Virtual Environment:
+
+1. Run `pip install -r requirements.txt` to install needed Python libraries.
+
+2. Run `python db-setup.py` to setup and create new Postgresql database and needed tables in it.  
+
+3. Use your favourite scheduling method to set `python spamcheck.py` to run regularly.
+