aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README35
1 files changed, 16 insertions, 19 deletions
diff --git a/README b/README
index 6dcc224..b38b38c 100644
--- a/README
+++ b/README
@@ -1,25 +1,22 @@
-tor-metrics: statically generated tor metrics and statistics
+allium: statically generated tor metrics and statistics - https://yui.cat/
- tor-metrics generates a set of HTML documents which represent the total set
- of tor relays at runtime, sorting by ASN/country/platform/flag, respectful
- Onionoo queries (If-Modified-Since) and 100% certified Javascript-freeā„¢
+ allium generates a set of HTML documents which represent the total set of tor
+ relays at the time of execution
- demo: https://yui.cat/
-
- $ ./generate.py
- $ ls ./www
- all.html contact/ families.html flag/ networks.html relay/
- as/ country/ family/ index.html platform/ static/
- $
+ allium is heavily inspired by the official tor metrics project[0] and serves
+ as a javascript-free, statically-generated clean room implementation. the
+ primary goals of the project are to be fast (static), use few API queries
+ (one), and to present information in a condensed, readable format
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
+ - 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
- note: this project includes country flags from GoSquared[0] and relay flags
- from the Tor Project[1]; licenses are included in this project's root
- directory
+ note: this project includes country flags from GoSquared[1] and relay flags
+ from the Tor Project[2], the licenses of which are included in this project's
+ root directory
- [0] https://github.com/gosquared/flags
- [1] https://www.torproject.org/
+ [0] https://metrics.torproject.org/
+ [1] https://github.com/gosquared/flags
+ [2] https://www.torproject.org/