aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJordan <me@jordan.im>2022-06-24 19:12:16 -0700
committerJordan <me@jordan.im>2022-06-24 19:12:16 -0700
commitdc3236009ea32ff276d8a8ee635a4993951a0911 (patch)
tree1654d656cc1f029b243b5ccf3a1f5b9e753f0fd5
parent2e235318786d16fe6a07ed61f6c4ff034b3e3c75 (diff)
downloadallium-dc3236009ea32ff276d8a8ee635a4993951a0911.tar.gz
allium-dc3236009ea32ff276d8a8ee635a4993951a0911.zip
readme
-rw-r--r--README34
1 files 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/