1 files changed, 18 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..d7119c8
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+Tor Metrics :: https://yui.cat/ source
+
+Network-oriented Tor metrics and statistics made with love (not javascript)
+
+# Requirements: python3, jinja2 (pip install jinja2)
+
+git clone https://github.com/tempname1024/tor-metrics.git cd
+tor-metrics/tor-metrics python3 generate.py
+
+# Files are written to www/ by default
+
+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
+
+This project includes country flags from https://github.com/gosquared/flags and
+relay flags from https://www.torproject.org/