From a185b763930f1d7ad410f1381bbdad362ec813b8 Mon Sep 17 00:00:00 2001
From: 17ms <arttu@golfed.xyz>
Date: Sun, 7 Jul 2024 17:19:00 +0300
Subject: [PATCH] docs: development and usage guides

---
 README.md | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index e72082c..62152b3 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,18 @@
 # Ethereum network sender address mapper
 
-Script that, once deployed in a Docker container, monitors a live feed of the Ethereum network via a WebSocket connection, stores the sender addresses, and creates statistics of the most active addresses.
+Script that, once deployed in a Docker container, monitors a live feed of the Ethereum network via a WebSocket connection, stores the sender addresses with transaction counts, and creates statistics of the most active addresses.
+
+## Development
+
+```shell
+mkvirtualenv chainmapper # OR 'workon chainmapper'
+pip3 install -r requirements.txt
+touch .env && echo -e "MODE=\"development\"\nEXPORT_INTERVAL=\"60\"" > .env # 60 seconds export period for testing
+```
 
 ## Usage
 
 ```shell
-$ echo "TODO"
+chmod +x ./scripts/deploy.sh
+./scripts/deploy.sh
 ```