diff options
author | Jordan <me@jordan.im> | 2020-12-11 19:46:57 -0700 |
---|---|---|
committer | Jordan <me@jordan.im> | 2020-12-11 19:46:57 -0700 |
commit | 7d530a90fe15fe912ffa84424d9d24e20144fb38 (patch) | |
tree | cab5bf9fc3a78822631fef31a51c056428407a4e | |
parent | c0979ef66edba31e0c3a31f0770a27b32082eb21 (diff) | |
download | allium-7d530a90fe15fe912ffa84424d9d24e20144fb38.tar.gz allium-7d530a90fe15fe912ffa84424d9d24e20144fb38.zip |
add install instructions to readme
-rw-r--r-- | README | 10 |
1 files changed, 10 insertions, 0 deletions
@@ -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 |