From 712cfaf5a09d337904cfeafbdb2986e0e73fdd2a Mon Sep 17 00:00:00 2001
From: Ryan Tharp <neuro@interx.net>
Date: Fri, 3 May 2019 15:16:28 -0700
Subject: [PATCH] add README

---
 contrib/node-monitor/README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 contrib/node-monitor/README.md

diff --git a/contrib/node-monitor/README.md b/contrib/node-monitor/README.md
new file mode 100644
index 000000000..1e833fd66
--- /dev/null
+++ b/contrib/node-monitor/README.md
@@ -0,0 +1,26 @@
+# Building / Running
+
+after building lokinet
+
+```
+cd contrib/node-monitor
+npm install
+npm start
+```
+
+and wait 30s for final score
+
+# Scoring
+
+Lokinet gets a point for everything it does correctly.
+
+Currently:
+- succesful ping to snode (1 per second after a snode is discovered)
+- session with snode established
+- got a router from exploration
+- Hanlding DHT S or R message
+- a path is built
+- obtained an exit via
+- granted exit
+- IntroSet publish confirmed
+- utp.session.sendq. has a min zero count (no blocked buffers on routers)