Sfoglia il codice sorgente

docs: update README.md

poesty 8 mesi fa
parent
commit
60c3ee8eb7
1 ha cambiato i file con 14 aggiunte e 1 eliminazioni
  1. 14 1
      README.md

+ 14 - 1
README.md

@@ -1,2 +1,15 @@
-# Fedi-Cleaner
+# Fedi Cleaner
 
+A tool to help you clean your Fediverse account's following/followers/lists/blocks/mutes/...
+
+## Prerequisite
+
+* Your Fediverse instance supports Mastodon API
+* You have a good internet connection (for validating those accounts)
+* You know how to setup Python envirnoment
+
+## Steps
+
+1. `pip install -r requirements.txt`
+2. `cp config.py.example config.py` and edit the configuration
+3. `python3 main.py`