Place extension documentation within the extensions folder.
authorSteven Black <redacted>
Tue, 23 Feb 2016 00:39:41 +0000 (19:39 -0500)
committerSteven Black <redacted>
Tue, 23 Feb 2016 00:39:41 +0000 (19:39 -0500)
extensions/readme.md [new file with mode: 0644]

diff --git a/extensions/readme.md b/extensions/readme.md
new file mode 100644 (file)
index 0000000..a039d4c
--- /dev/null
@@ -0,0 +1,18 @@
+# Extensions
+
+Use subfolders under the `extensions` folder to house extensions for additional variants of 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:
+
+    python3 updateHostsFile.py [--auto] --extensions porn
+
+Using Python 2.7:
+
+    python updateHostsFile.py [--auto] --extensions porn
git clone https://git.99rst.org/PROJECT