From 19abc18f903c28f57ad357858fb4dd2bd3a65f50 Mon Sep 17 00:00:00 2001
From: Enju Aihara <5-EnjuAihara@users.noreply.gitlab.varis.social>
Date: Fri, 4 Mar 2022 18:18:11 +0100
Subject: [PATCH] added readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e90aa5b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Fedi block API
+
+Used to see which instances block yours.
+
+## software used:
+- python 3.10.2
+- node v17.6.0
+- yarn 1.22.17
+
+## how to use:
+
+Copy the preloaded database to the live database
+
+`cp blocks_preloaded.db blocks.db`
+
+Start the mastodon API
+
+```
+cd mastodon_api
+yarn install
+node .
+```
+
+Fill the database with blocks.
+
+`python fetch_blocks.py`
+
+## License
+
+[AGPLv3+NIGGER](https://plusnigger.autism.exposed/)
\ No newline at end of file