From ed2498790b3167b07f456726664e9b8015da1502 Mon Sep 17 00:00:00 2001
From: Alexey Tsymbal <tsymbal.aleksey@gmail.com>
Date: Wed, 2 Mar 2022 16:27:50 +0400
Subject: [PATCH] Add readme (#3)

Co-authored-by: Alexey Tsymbal <alexey@gotiggy.com>
---
 README.md | 33 ++++++++++++++++++++++++++++++++-
 1 file changed, 32 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 97052e0..fb87e38 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,37 @@
 # Saber monitoring service
 
-A reference implementation of a service running `@dialectlabs/monitor` for saber wars.
+A reference implementation of `@dialectlabs/monitor` used to power notifications in a twitter bot https://twitter.com/saberwarsbot.
+The twitter bot sends the following tweets
+
+## Votes cast 
+Votes cast tweet is sent at 11AM ET and 7PM ET and includes the following data
+- Progress for % of votes cast vs. previous epoch.
+- The time left in the epoch.
+- Top vote getter
+
+```
+Epoch 7 progress: 77% of votes committed
+449,646,909 votes committed (581,650,867 cast in epoch 6)
+Vote leader: Saber UST-USDC LP | 194,329,794 votes and 432,183 SBR/day
+Time remaining in epoch: 01:00:11:58 
+
+⚔️⚔️⚔️⚔️⚔️#SABERWARS⚔️⚔️⚔️⚔️⚔️
+```
+
+## Whale alert
+
+Whale alert is sent anytime a gauge changes by more than 4,000,000 votes and includes the following data
+- Number of votes committed to gauge.
+- Updated reward.
+
+```
+⚔️🐳🚨 Whale alert! 🚨🐳⚔️
+
+4,489,856 votes committed to Saber cUSDC-cUSDT LP | 49,184 SBR/day
+
+⚔️⚔️⚔️⚔️⚔️#SABERWARS⚔️⚔️⚔️⚔️⚔️
+```
+
 See https://github.com/dialectlabs/monitor for details on the notifications module.
 
 ## Development