From dd3b20bbae1b81372f0b4c788262bfb5c9e4b2d3 Mon Sep 17 00:00:00 2001
From: Kay Faraday <iexoo7ahth8s@freak.university>
Date: Sun, 12 Jun 2022 02:07:49 +0000
Subject: [PATCH] add README

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5325393
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# replacer
+
+A reverse proxy that applies string replacements to response bodies.
+This was developed for [Freak University's onion](http://freakuup7twznw6ri3e246fooe4ctw66rt7chbxcbc3p63lfky7dkvid.onion/)
+in order to replace clearnet links (such as images and the websocket URL) with onion links, ensuring that no clearnet requests are made to the site.
+
+## Usage
+
+```
+$ pip install -r requirements.txt
+$ cp config.example.toml config.toml
+$ # edit as necessary
+$ ./replacer.py
+$ # now configure your reverse proxy to proxy to replacer
+```