From 67f58567788ae59b866fd9f84e0490bb09f7aa7b Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoitm@matrix.org>
Date: Mon, 20 Mar 2023 11:25:39 +0100
Subject: [PATCH] Move localazy.json configuration file to its own folder and
 add a README.md

---
 tools/localazy/README.md                      | 23 +++++++++++++++++++
 localazy.json => tools/localazy/localazy.json |  0
 2 files changed, 23 insertions(+)
 create mode 100644 tools/localazy/README.md
 rename localazy.json => tools/localazy/localazy.json (100%)

diff --git a/tools/localazy/README.md b/tools/localazy/README.md
new file mode 100644
index 0000000000..54ee857242
--- /dev/null
+++ b/tools/localazy/README.md
@@ -0,0 +1,23 @@
+# Localazy
+
+Localazy is used to host the source strings and their translations.
+
+## Localazy project
+
+To add new strings, or to translate existing strings, go the the Localazy project: [https://localazy.com/p/element](https://localazy.com/p/element).
+
+Never edit manually the files `localazy.xml`!.
+
+## CLI Installation
+
+To install the Localazy client, follow the instructions from [here](https://localazy.com/docs/cli/installation).
+
+## Download translations
+
+In the root folder of the project, run:
+
+```shell
+localazy download --config ./tools/localazy/localazy.json
+```
+
+It will update all the `localazy.xml` resource files. In case of merge conflicts, just erase the files and download again using the Localazy client.
diff --git a/localazy.json b/tools/localazy/localazy.json
similarity index 100%
rename from localazy.json
rename to tools/localazy/localazy.json