From ecc4e0b88966b9e3452e6428a8e8dbb1a7428c7c Mon Sep 17 00:00:00 2001
From: Kipras Melnikovas <kipras@kipras.org>
Date: Fri, 6 Jan 2023 05:00:28 +0200
Subject: [PATCH] create README for lang/ - how to update translations

Signed-off-by: Kipras Melnikovas <kipras@kipras.org>
---
 lang/README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 lang/README.md

diff --git a/lang/README.md b/lang/README.md
new file mode 100644
index 00000000..ef696635
--- /dev/null
+++ b/lang/README.md
@@ -0,0 +1,19 @@
+### how to update
+
+1. find missing keys:
+
+```sh
+MINE=<your-lang>.json
+BASE=en-US.json
+
+jq 'keys' < $BASE > base
+jq 'keys' < $MINE > mine
+
+diff -c2 base mine
+# will print missing keys.
+# add them to $MINE
+```
+
+2. for each key, search in your editor where it is used, and additionally visit the [live demo website](https://app.umami.is/share/8rmHaheU/umami.is), to better understand the usage context.
+
+3. translate. though, if you don't fully understand the context of how a translation is used, note this in the PR review.