]> git.ipfire.org Git - thirdparty/blocklistproject/lists.git/commitdiff
Update README.md
authorgap579137 <30596626+gap579137@users.noreply.github.com>
Mon, 22 Jun 2020 14:13:21 +0000 (09:13 -0500)
committergap579137 <30596626+gap579137@users.noreply.github.com>
Mon, 22 Jun 2020 14:13:21 +0000 (09:13 -0500)
README.md

index cfb4f58032212d91daf6bbf67d612c9410aef3f4..30bf60f330588599ae00a8a46ee48145c9e028ae 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,47 @@
-# Lists
-Primary Lists
+
+# The Block List Project
+**Last Updated:** 2020-06-22 
+
+- [Details](#details)
+- [Usage](#usage)
+  - [Using with Pi-Hole](#using-with-pi-hole)
+  - [Using with other tools](#using-with-other-tools)
+- [License](#license)
+- [Reporting Conversion Issues](#reporting-conversion-issues)
+
+&nbsp;
+
+# Details:
+These lists were created be the founder of the project wanted something with a little more control over what is being blocked. Many lists are all or nothing. We set out to create lists with more control over what is being blocked. 
+
+
+&nbsp;
+
+# Usage:
+These converted files can be used with various DNS and domain-blocking tools:
+
+## Using with [Pi-Hole](https://pi-hole.net/):
+
+1. Copy the link to the Pi-Hole format for the desired list (from the appropriate table below).
+2. Add the URL to your Pi-Hole's block lists (**Login** > **Group Management** > **Adlists** > **Paste list URL in "Address" field, add comment** > **Click "Add"**)
+3. Update Gravity (**Tools** > **Update Gravity** > **Click "Update"** )
+
+
+<sup>Instructions current as of Pi-Hole 5.0
+*Not supported by or affiliated with Pi-Hole.</sup> 
+
+## Using with other tools:
+We are currently working on verifying compatibility with other tools. Please stand by. If you have a suggestion on a tool we should support please comment on our [Reddit](https://www.reddit.com/r/blocklistproject/) page. 
+
+
+# License:
+Each converted / modified list file is licensed under the same license as the original list.
+
+For more details, see the [LICENSES](LICENSES) file.
+
+&nbsp;
+
+
+<sup>These files are provided "AS IS", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, arising from, out of or in connection with the files or the use of the files.</sup>
+
+<sub>Any and all trademarks are the property of their respective owners.</sub>
\ No newline at end of file