aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Daniel Washburn <daniel@washburn.at> 2019-08-03 20:38:34 +0000
committerGravatar Daniel Washburn <daniel@washburn.at> 2019-08-03 17:03:40 -0400
commitdad1334e9a699c488aae814e67723b7fbb634a33 (patch)
tree59c460f5da9c201a5a5db9e363151fd9b15cb11b
parent1f0da5d88fe2708389d1f7bcde6a9c96187da5f1 (diff)
downloadadservers-littlesnitch-dad1334e9a699c488aae814e67723b7fbb634a33.tar.gz
adservers-littlesnitch-dad1334e9a699c488aae814e67723b7fbb634a33.tar.bz2
adservers-littlesnitch-dad1334e9a699c488aae814e67723b7fbb634a33.zip
Add README.md
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cd51268
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# AdServers for Little Snitch 4
+
+A very ~~hacky~~basic script to convert [Peter Lowe's AdServers blocklist][1] to the JSON-based [Little Snitch 4][2] [.lsrules][3] format, suitable for use as a [Rule group subscription][4].
+
+It is worth noting that [@pgl][5] provides a [littlesnitch-rule-group-subscriptions][6] format, but this script uses the more compact `denied-remote-hosts` array format introduced in Little Snitch 4.2
+
+This script requires internet access at least once, to curl the host blocklist, and emits JSON on stdout.
+
+Subscribe rules are embeddable using the `x-littlesnitch:` URL scheme.
+
+I eat my own dog food, and if you think you might also enjoy the taste I offer it to you with with the usual caveats that this is a best-effort endeavor, and if it breaks your system you get to keep both halves.
+
+[1]: https://pgl.yoyo.org/as/
+[2]: https://www.obdev.at/products/littlesnitch/index.html
+[3]: https://help.obdev.at/littlesnitch/ref-lsrules-file-format
+[4]: https://help.obdev.at/littlesnitch/lsc-rule-group-subscriptions#subscribing
+[5]: https://twitter.com/pgl
+[6]: https://pgl.yoyo.org/adservers/serverlist.php?hostformat=littlesnitch-rule-group-subscriptions