README

README.md

@@ -0,0 +1,31 @@
+# Bukubukuchagama
+
+Give them a break, they're trying hard.
+
+### The what?
+
+Automatic scanners suck. So give them some tea!
+
+Point your reverse proxy matching common scanner paths at this little server.
+It responds to any request with HTTP code 418 (full compliance with RFC 7168 section 2.3.2), and gives them a tasteful image of girls with teapots.
+
+### Want it?
+
+Put your own teapot girls in `./teapots/` in webp format and enjoy!
+
+`new-pots.py` is a script to batch-download tasteful teapot girls from danbooru and convert them to .webp (requires ImageMagick in PATH)
+
+---
+
+### Run
+
+```shell
+# Build it!
+zig build -Doptimize=ReleaseFast
+
+# Run it!
+./zig-out/bin/bukubukuchagama
+```
+
+Listens on `127.0.0.1:8418` by default.
+Wrap in your daemon management system of choosing.