aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJordan <me@jordan.im>2019-11-09 00:58:01 -0700
committerJordan <me@jordan.im>2019-11-09 00:58:01 -0700
commita189af05f77c0dcb6947f536acc051bd0795f3bb (patch)
treeed0b3881cd4fef356ce103327591790d88520cd5 /README
parentded0c17e1832a7756370fe91369e0b8942c5f7b0 (diff)
downloadallium-a189af05f77c0dcb6947f536acc051bd0795f3bb.tar.gz
allium-a189af05f77c0dcb6947f536acc051bd0795f3bb.zip
README, TODO updates
Diffstat (limited to 'README')
-rw-r--r--README20
1 files changed, 12 insertions, 8 deletions
diff --git a/README b/README
index 4e65608..f1858bc 100644
--- a/README
+++ b/README
@@ -1,19 +1,23 @@
Tor Metrics :: https://yui.cat/ source
+* Relay listings statically generated at runtime
+* Sort by family, ASN, country, and platform
+* Respectful Onionoo requests (If-Modified-Since)
+* Javascript-free
-Network-oriented Tor metrics and statistics made with love (not javascript)
+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
+* Generalize sorting functions, avoid redundancy
-# Requirements: python3, jinja2 (pip install jinja2)
+INSTALL:
+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
+Files are written to www/ by default
This project includes country flags from https://github.com/gosquared/flags and
relay flags from https://www.torproject.org/