From 78549a76b6c0813f877a2660fdb035b4e251be96 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Tue, 18 Sep 2018 15:50:10 +0100 Subject: [PATCH] Update readme --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index be03098..0d4c4be 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,10 @@ This tool currently *does not* write to the database in any way, so should be safe to run. If the `-o` option is specified then SQL will be written to the given file that would change the tables to match the calculated state. (Note that if `-t` is given then each change to a particular state group is wrapped -in a transaction) +in a transaction). + +The tool will also ensure that the generated state deltas do give the same state +as the existing state deltas. ## Algorithm @@ -26,6 +29,10 @@ L2 <-------------------- L2 <---------- ... The sizes and number of levels used can be controlled via `-l`. +**Note**: Increasing the sum of the sizes of levels will increase the time it +takes for to query the full state of a given state group. By default Synapse +attempts to keep this below 100. + ## Example