From 36aa46c4861467c1aff95c2d0b80ce4799fe9254 Mon Sep 17 00:00:00 2001
From: Ruakij <ruakij@ruekov.eu>
Date: Wed, 5 Apr 2023 20:36:18 +0200
Subject: [PATCH] Add documentation

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

diff --git a/README.md b/README.md
index 61a05a2..06b6a20 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,7 @@ Collection of Dockerfiles created to build & pack various tools.
 - [2. Tools](#2-tools)
     - [2.1. Bandwhich](#21-bandwhich)
     - [2.2. auto-editor](#22-auto-editor)
+    - [2.3. synapse-compress-state](#23-synapse-compress-state)
 <!-- /TOC -->
 
 <br>
@@ -80,3 +81,20 @@ docker run -v /home/ruakij/Videos:/video auto-build --no-open --silent-speed 8 -
 
 ### 2.2.3. Comment
 TODO: Unfortunately the tool requires ffmpeg which is a huge tool and blows up the size of the image. I have to find a way to use a minimized version of it.
+
+<br>
+
+## 2.3. synapse-compress-state
+Includes synapse_auto_compressor
+
+### 2.3.1. Source
+>This workspace contains experimental tools that attempt to reduce the number of rows in the state_groups_state table inside of a Synapse Postgresql database.
+
+https://github.com/matrix-org/rust-synapse-compress-state
+
+<br>
+
+### 2.3.2. Example
+```
+docker run --net container:synapse synapse-compress-state synapse_auto_compressor -p postgresql://synapse:synapse@127.0.0.1/synapse -c 500 -n 100
+```