commit 42b6def28d04b7fee8033bc063fac980abe0b069
Author: spla <salvador.pla@gmail.com>
Date:   Sun May 17 12:28:47 2020 +0200

    Added README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3fe99cc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Fediverse Stats
+This code gets all peers from running Mastodon or Pleroma host server and then all peers from host server's peers. Goal is to collect maximum number
+of alive fediverse's servers and then query their API to obtain their registered users (if their API provide such information).
+At the end it post the results to host server bot account.
+
+### Dependencies
+
+-   **Python 3**
+-   Postgresql server
+-   Mastodon or Pleroma running server.
+
+### Usage:
+
+Within Python Virtual Environment:
+
+1. Run `python db-setup.py` to setup and create new Postgresql database and needed tables in it.
+
+2. Run `python setup.py` to get your bot's access token of your Mastodon or Pleroma server existing account. It will be saved to 'secrets/secrets.txt' for further use.
+
+3. Run `python getworld.py` to get all peers from your host and the whole world of fediverse's servers (or almost the whole world).
+
+4. Run `python fediverse.py` to query world alive servers API.
+
+5. Use your favourite scheduling method to set ratio.py to run regularly. 
+
+Note: install all needed packages with 'pip install package' or use 'pip install -r requirements.txt' to install them. 
+
+