aboutsummaryrefslogtreecommitdiff
path: root/python/vanguards/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/vanguards/README')
-rw-r--r--python/vanguards/README12
1 files changed, 12 insertions, 0 deletions
diff --git a/python/vanguards/README b/python/vanguards/README
new file mode 100644
index 000000000000..50f8d7b3c647
--- /dev/null
+++ b/python/vanguards/README
@@ -0,0 +1,12 @@
+vanguards is a controller addon for Tor onion services.
+
+It's aimed at Tor onion services that require high security as
+soon as possible, ahead of their official Tor-code releases.
+
+Having Tor installed is not required for building.
+The Tor installation does not have to be from SBo.
+Vanguards requires Tor 0.3.3.x or above, and Tor 0.3.5.x is
+preferred.
+
+A python 3 module will be compiled if python 3 is installed on
+the system during compile time.