Documentation: clarify the role of extensions, and how they work.
authorStevenBlack <redacted>
Mon, 14 May 2018 03:46:22 +0000 (23:46 -0400)
committerStevenBlack <redacted>
Mon, 14 May 2018 03:46:22 +0000 (23:46 -0400)
extensions/readme.md
readme_template.md

index 7fb87e5cf0512280fdb2fdf8e23dda2b9e48d43e..056d4213071f46f813e33bb363d55ea7411aef75 100644 (file)
@@ -1,19 +1,21 @@
 # Extensions
 
-Use subfolders under the `extensions` folder to house extensions to the final unified hosts file.
+Use subfolders under this `extensions` folder to house data sources for extensions to the default unified hosts file.
 
-Currently, this repo includes four extensions:
+Currently, this repo includes data sources for four extensions:
 
+* `fakenews` for fake news sites.
 * `gambling` for common online betting sites,
-* `social` for common social media sites,
 * `porn` for porn sites, and
-* `fakenews` for fake news sites.
+* `social` for common social media sites,
 
 
 Here are some sample calls, which vary which extensions are included.
 
 **Using Python 3**:
 
+Create a hosts file that includes domain blocking for porn, social media, and gambling.
+
     python3 updateHostsFile.py --auto --extensions porn social gambling
 
 or, in short form:
@@ -30,5 +32,3 @@ or, in short form:
 
     python updateHostsFile.py -a -e porn social gambling
 
-
-More built-in extensions are coming soon.
index e69dc6f51ac313aa98b9bbbf29fbadcbde87f8e0..5e9033c085496ec54f5968de90ea763a1fde633d 100644 (file)
@@ -33,9 +33,14 @@ Host file source | Description | Home page | Raw hosts | Update frequency | Lice
 
 
 ## Extensions
-The unified hosts file is extensible.  You manage extensions by curating the
-`extensions/` folder tree. See the `fakenews`, `social`, `gambling`, and `porn` extension
-folders.
+The unified hosts file is extensible.  Extensions are used to block domains by category.  
+
+Extensions are optional, and are added to the base hosts file.  Extensions are combined in variuous ways wth the default hosts file, and the combined products are stored in the [`alternates`](https://github.com/StevenBlack/hosts/tree/master/alternates) folder.
+
+For example, you may want to block porn domains in addition to the adware and malware we block by default.  That hosts file is stored in the porn subfolder of the [alternates](https://github.com/StevenBlack/hosts/tree/master/alternates) folder.  
+
+Data for extensions is stored in the [extensions folder](https://github.com/StevenBlack/hosts/tree/master/extensions). You manage extensions by curating the
+[extensions folder tree](https://github.com/StevenBlack/hosts/tree/master/extensions) where you will find the data for `fakenews`, `social`, `gambling`, and `porn` extension data that we maintain and provide for you.
 
 ## Generate your own unified hosts file
 
git clone https://git.99rst.org/PROJECT