From 26c8fdcad9bf9f263b5f72ae59a9f2dac4f42e57 Mon Sep 17 00:00:00 2001
From: Jake Jarvis <jake@jarv.is>
Date: Wed, 7 Dec 2022 17:59:52 +0000
Subject: [PATCH] Update README.md

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README.md b/README.md
index a1b59f3..b39b5c0 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,31 @@
 # Mastodon customizations
 
+Random opinionated helper scripts & front-end customizations for my [personal Mastodon instance](https://fediverse.jarv.is/about) (running on [`glitch-soc`](https://github.com/glitch-soc/mastodon)). You probably don't want to use any of this as-is.
+
+## Usage
+
+**DEFINITELY DO NOT JUST RUN THIS IF YOU'RE NOT ME!!! 😊**
+
+```sh
+git clone https://github.com/jakejarvis/mastodon-scripts.git /home/mastodon/scripts
+git config --global --add safe.directory /home/mastodon/scripts
+
+cd /home/mastodon/live
+git apply --allow-binary-replacement --whitespace=warn /home/mastodon/scripts/patches/*.patch || true
+RAILS_ENV=production bundle exec rails assets:precompile
+
+chown -R mastodon:mastodon /home/mastodon/{scripts,live}
+
+systemctl restart mastodon-web
+```
+
+## Patches
+
+- [`hide-signup.patch`](patches/hide-signup.patch): Hide the "create account" button (for aesthetics, not security!)
+- [`favicons.patch`](patches/favicons.patch): Use custom icon images instead of Mastodon logo
+- [`robots.patch`](patches/robots.patch): Disallow search engines for all of Mastodon
+- [`system-font.patch`](patches/favicons.patch): Use the system's default sans-serif font stack instead of Roboto
+
 ## License
 
 MIT