From 93bef6ea15a726c9e0d61bf8236bf17ca4ad0278 Mon Sep 17 00:00:00 2001
From: Bray <97918955+IGuessItsBray@users.noreply.github.com>
Date: Fri, 24 Mar 2023 11:05:25 -0400
Subject: [PATCH] feat: add redis requirements to readme (#542)

---
 README.md              | 2 +-
 pluralkit.conf.example | 3 ++-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 81b05557..97662723 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ PluralKit is a Discord bot meant for plural communities. It has features like me
 PluralKit has a Discord server for support, feedback, and discussion: https://discord.gg/PczBt78 
 
 # Requirements
-Running the bot requires [.NET 5](https://dotnet.microsoft.com/download) and a PostgreSQL database. It should function on any system where the prerequisites are set up (including Windows).
+Running the bot requires [.NET 5](https://dotnet.microsoft.com/download), a PostgreSQL database and a Redis database. It should function on any system where the prerequisites are set up (including Windows).
 
 Optionally, it can integrate with [Sentry](https://sentry.io/welcome/) for error reporting and [InfluxDB](https://www.influxdata.com/products/influxdb-overview/) for aggregate statistics.
 
diff --git a/pluralkit.conf.example b/pluralkit.conf.example
index 06e3fc05..44ce1ef0 100644
--- a/pluralkit.conf.example
+++ b/pluralkit.conf.example
@@ -4,6 +4,7 @@
       "Token": "BOT_TOKEN_GOES_HERE",
       "ClientId": 466707357099884544,
     },
-    "Database": "Host=localhost;Port=5432;Username=myusername;Password=mypassword;Database=mydatabasename"
+    "Database": "Host=localhost;Port=5432;Username=myusername;Password=mypassword;Database=mydatabasename",
+    "RedisAddr": "host:port"
   }
 }
\ No newline at end of file