More readme refinements.
authorSteven Black <redacted>
Tue, 23 Feb 2016 15:05:16 +0000 (10:05 -0500)
committerSteven Black <redacted>
Tue, 23 Feb 2016 15:05:16 +0000 (10:05 -0500)
extensions/readme.md
readme.md
readme_template.md

index a039d4c37600a70cde415259d98bebe60f10768f..d9b1c678ce3736d45127add27f3e203d87bcca12 100644 (file)
@@ -1,18 +1,25 @@
 # Extensions
 
-Use subfolders under the `extensions` folder to house extensions for additional variants of the final amalgamated
-hosts file.
+Use subfolders under the `extensions` folder to house extensions to the final amalgamated hosts file.
 
 Currently this repo includes a `porn` extension which you can optionally add to your final amalgamated file.
 
-More built-in extensions are coming soon.
-
 Here's a sample call to include the `porn` extension.
 
-Using Python 3:
+**Using Python 3**:
+
+    python3 updateHostsFile.py --extensions porn
+
+or, in short form:
 
-    python3 updateHostsFile.py [--auto] --extensions porn
+    python3 updateHostsFile.py -e porn
 
-Using Python 2.7:
+**Using Python 2.7**:
 
-    python updateHostsFile.py [--auto] --extensions porn
+    python updateHostsFile.py --extensions porn
+
+or, in short form:
+
+    python updateHostsFile.py -e porn
+
+More built-in extensions are coming soon.
index c352b842598d649fbabd2906e5cc1eb8532968fb..05f1246c26f72fe7cb68788448056f978814e734 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -65,21 +65,21 @@ Using Python 2.7:
 
 Command line options:
 
-`--auto`, `-a`: run the script without prompting. When `--auto` is invoked,
+`--auto`, or `-a`: run the script without prompting. When `--auto` is invoked,
 
 * Host data sources, including extensions, are updated.
 * No extensions are included by default.  Use the `--extensions` or `-e` flag to include any you want.
 * Your active hosts file is *not* replaced unless you include the `--replace` flag.
 
-`--replace`, `-r`: trigger replacing your active hosts file with the new hosts file. Use along with `--auto` to
+`--replace`, or `-r`: trigger replacing your active hosts file with the new hosts file. Use along with `--auto` to
 force replacement.
 
-`--ip nnn.nnn.nnn.nnn`, `--i nnn.nnn.nnn.nnn`: the IP address to use as the target.  Default is `0.0.0.0`.
+`--ip nnn.nnn.nnn.nnn`, or `-i nnn.nnn.nnn.nnn`: the IP address to use as the target.  Default is `0.0.0.0`.
 
-`--extensions ext1 ext2 ext3`, `-e ext1 ext2 ext3`: the names of subfolders below the `extensions` folder containing
+`--extensions ext1 ext2 ext3`, or `-e ext1 ext2 ext3`: the names of subfolders below the `extensions` folder containing
 additional category-specific hosts files to include in the amalgamation. Example: `--extensions porn` or `-e porn`.
 
-`--help`, `-h`: display help.
+`--help`, or `-h`: display help.
 
 ## How do I control which sources are amalgamated?
 
index 3d979c2ac797b0081c7705d3cffacf96f8b44cc7..b202a523df7fc3002362aa8851a8512ec41fdae2 100644 (file)
@@ -65,21 +65,21 @@ Using Python 2.7:
 
 Command line options:
 
-`--auto`, `-a`: run the script without prompting. When `--auto` is invoked,
+`--auto`, or `-a`: run the script without prompting. When `--auto` is invoked,
 
 * Host data sources, including extensions, are updated.
 * No extensions are included by default.  Use the `--extensions` or `-e` flag to include any you want.
 * Your active hosts file is *not* replaced unless you include the `--replace` flag.
 
-`--replace`, `-r`: trigger replacing your active hosts file with the new hosts file. Use along with `--auto` to
+`--replace`, or `-r`: trigger replacing your active hosts file with the new hosts file. Use along with `--auto` to
 force replacement.
 
-`--ip nnn.nnn.nnn.nnn`, `--i nnn.nnn.nnn.nnn`: the IP address to use as the target.  Default is `0.0.0.0`.
+`--ip nnn.nnn.nnn.nnn`, or `-i nnn.nnn.nnn.nnn`: the IP address to use as the target.  Default is `0.0.0.0`.
 
-`--extensions ext1 ext2 ext3`, `-e ext1 ext2 ext3`: the names of subfolders below the `extensions` folder containing
+`--extensions ext1 ext2 ext3`, or `-e ext1 ext2 ext3`: the names of subfolders below the `extensions` folder containing
 additional category-specific hosts files to include in the amalgamation. Example: `--extensions porn` or `-e porn`.
 
-`--help`, `-h`: display help.
+`--help`, or `-h`: display help.
 
 ## How do I control which sources are amalgamated?
 
git clone https://git.99rst.org/PROJECT