From 7d530a90fe15fe912ffa84424d9d24e20144fb38 Mon Sep 17 00:00:00 2001
From: Jordan <me@jordan.im>
Date: Fri, 11 Dec 2020 19:46:57 -0700
Subject: add install instructions to readme

---
 README | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README b/README
index b38b38c..b4cd081 100644
--- a/README
+++ b/README
@@ -8,7 +8,17 @@ allium: statically generated tor metrics and statistics - https://yui.cat/
   primary goals of the project are to be fast (static), use few API queries
   (one), and to present information in a condensed, readable format
 
+  INSTALL
+
+    $ pip install -r requirements.txt
+    $ cd allium
+    $ ./generate.py
+
+    Files will be generated in the ./www directory by default, configurable by
+    editing config.py; the only non-standard dependency is Jinja2>=2.11.2
+
   TODO
+
     - top exit/guard/relay families (see https://nusenu.github.io/OrNetStats/)
     - interesting statistics (ASN exit concentration, IPv6-supporting relays)
     - implement something similar to https://metrics.torproject.org/bubbles.html
-- 
cgit v1.2.3-54-g00ecf