From 7a1999f11759cd2b9cf625cbe241ba47130d72d5 Mon Sep 17 00:00:00 2001
From: emdee <emdee>
Date: Tue, 29 Nov 2022 15:27:16 +0000
Subject: [PATCH] Updated README

---
 README.md           | 22 ++++++++++++++++++++++
 exclude_badExits.py | 22 ++++++++++++++++++++++
 2 files changed, 44 insertions(+)

diff --git a/README.md b/README.md
index 9e983e7..3a1a2f6 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,17 @@ Use the GoodNodes/Onions list to list onion services you want the
 Introduction Points whitelisted - these points may change daily
 Look in tor's notice.log for warnings of 'Every introduction point for service'
 
+```--hs_dir``` ```default='/var/lib/tor'``` will make the program 
+parse  the files named ```hostname``` below this dir to find 
+Hidden Services to whitelist.
+
+The Introduction Points can change during the day, so you may want to
+rerun this program to freshen the list of Introduction Points. A full run
+that processes all the relays from stem can take 30 minutes, or run with:
+
+```--saved_only``` will run the program with just cached information
+on the relats, but will update the Introduction Points from the Services.
+
 /etc/tor/yaml/torrc-badnodes.yaml
 
 BadNodes:
@@ -113,7 +124,18 @@ To be "good" the ContactInfo must:
 5. must have a fingerprint list in the file
 6. must have the FP that got us the contactinfo in the fingerprint list in the file.
 
+```--wait_boot``` is the number of seconds to wait for Tor to booststrap
+
+```--wellknown_output``` will make the program write the well-known files
+(```/.well-known/tor-relay/rsa-fingerprint.txt```) to a directory.
+
+```--torrc_output``` will write a file of the commands that it sends to
+the Tor controller, so you can include it in a ```/etc/toc/torrc```.
+
+```--relays_output write the download relays in json to a file. The relays
+are downloaded from https://onionoo.torproject.org/details
 
 For usage, do ```python3 exclude_badExits.py --help`
+See [exclude_badExits.txt](./exclude_badExits.txt)
 
 
diff --git a/exclude_badExits.py b/exclude_badExits.py
index 7d62086..19d100e 100644
--- a/exclude_badExits.py
+++ b/exclude_badExits.py
@@ -64,6 +64,17 @@ Use the GoodNodes/Onions list to list onion services you want the
 Introduction Points whitelisted - these points may change daily
 Look in tor's notice.log for warnings of 'Every introduction point for service'
 
+```--hs_dir``` ```default='/var/lib/tor'``` will make the program 
+parse  the files named ```hostname``` below this dir to find 
+Hidden Services to whitelist.
+
+The Introduction Points can change during the day, so you may want to
+rerun this program to freshen the list of Introduction Points. A full run
+that processes all the relays from stem can take 30 minutes, or run with:
+
+```--saved_only``` will run the program with just cached information
+on the relats, but will update the Introduction Points from the Services.
+
 /etc/tor/yaml/torrc-badnodes.yaml
 {sBAD_NODES}
 ```
@@ -124,8 +135,19 @@ To be "good" the ContactInfo must:
 5. must have a fingerprint list in the file
 6. must have the FP that got us the contactinfo in the fingerprint list in the file.
 
+```--wait_boot``` is the number of seconds to wait for Tor to booststrap
+
+```--wellknown_output``` will make the program write the well-known files
+(```/.well-known/tor-relay/rsa-fingerprint.txt```) to a directory.
+
+```--torrc_output``` will write a file of the commands that it sends to
+the Tor controller, so you can include it in a ```/etc/toc/torrc```.
+
+```--relays_output write the download relays in json to a file. The relays
+are downloaded from https://onionoo.torproject.org/details
 
 For usage, do ```python3 exclude_badExits.py --help`
+See [exclude_badExits.txt](./exclude_badExits.txt)
 
 """