From dc3236009ea32ff276d8a8ee635a4993951a0911 Mon Sep 17 00:00:00 2001 From: Jordan Date: Fri, 24 Jun 2022 19:12:16 -0700 Subject: readme --- README | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README b/README index 7664e47..b424932 100644 --- a/README +++ b/README @@ -10,31 +10,31 @@ optional arguments: ABOUT -allium generates a set of HTML documents which represent the total set of tor -relays at the time of execution + allium generates a set of HTML documents which represent the total set of tor + relays at the time of execution -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 + 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 REQUIRES -* python3 -* Jinja2>=2.11.2 + python3 + Jinja2>=2.11.2 INSTALL -$ pip install -r requirements.txt -$ cd allium -$ ./allium.py + pip install -r requirements.txt + cd allium + ./allium.py LICENSE -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; all code is published under UNLICENSE (public domain) + 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; all code is published under UNLICENSE (public domain) -[0] https://metrics.torproject.org/ -[1] https://github.com/gosquared/flags -[2] https://www.torproject.org/ + [0] https://metrics.torproject.org/ + [1] https://github.com/gosquared/flags + [2] https://www.torproject.org/ -- cgit v1.2.3-54-g00ecf