Add README.md

1 files changed, 20 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ab01f1d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# 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][7] 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.
+
+[x-littlesnitch:subscribe-rules?url=https%3A%2F%2Frmky.org%2Fas%2Flittlesnitch.lsrules]
+
+[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
\ No newline at end of file