From 5763bed56b3dd2219f8864140f4fa126b4d0f12d Mon Sep 17 00:00:00 2001
From: Dryusdan <contact@dryusdan.fr>
Date: Fri, 19 Jun 2020 10:05:23 +0200
Subject: [PATCH] Improve readme

---
 README.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3917625..01be7f8 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,14 @@
 # synapse-cleaner
 
-A bash script for vacuuming synapse
\ No newline at end of file
+A bash script for vacuuming synapse
+
+## Requirement : 
+- Bash
+- https://github.com/matrix-org/rust-synapse-compress-state
+
+## Installation 
+- Copy `utils/config.tpl` to `utils/config` and fill it.
+- Launch `bash synapse-cleaner.sh PARTIAL` to launch without vacuuming
+- Launch `bash synapse-cleaner.sh FULL` to launch with vacuuming, DB compressing... It's heavy for server but it's very usefull.
+
+