adding translation instructions

docs/translations.md

@@ -0,0 +1,53 @@
+# Localizing Tinode
+
+## Server
+
+The server sends emails to users upon creation of a new account and when the user requests to rest the password:
+
+* [server/templ/email-validation-en.templ](server/templ/email-validation-en.templ)
+* [server/templ/email-password-reset-en.templ](server/templ/email-password-reset-en.templ)
+
+Create a copy of the files naming them `email-password-reset-XX.teml` and `email-validation-XX.templ` where `XX` is the [ISO-631-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code of the new language. Translate the content and send a pull request with the new files. If you don't know how to create a pull request then just sent the files in any way you can.
+
+## Webapp
+
+The translations are located in two places: [src/i18n/](src/i18n/) and [service-worker.js](service-worker.js).
+
+In order to add a translation, copy `src/i18n/en.json` to a file named `src/i18n/XX.json` where `XX` is the [BCP-47](https://tools.ietf.org/rfc/bcp/bcp47.txt) code of the new language. If in doubt how to choose the BCP-47 language code, use a two letter [ISO-631-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). Only the `"translation":` line have to be translated, the `"defaultMessage"`, `"description"` etc should NOT be translated, they serve as help only, i.e.:
+
+```js
+"action_block_contact": {
+  "translation": "Bloquear contacto", // <<<---- Only this string needs to be translated
+  "defaultMessage": "Block Contact",  // This is the default message in English
+  "description": "Flat button [Block Contact]", // This is an explanation where/how the string is used.
+  "missing": false,
+  "obsolete": false
+},
+```
+
+When translating the `service-worker.js`, just add the strings directly to the file. Only two strings need to be translated "New message" and "New chat":
+
+```js
+const i18n = {
+  ...
+  'XX': {
+    'new_message': "New message",
+    'new_chat': "New chat",
+  },
+  ...
+```
+
+Please send a pull request with the new files. If you don't know how to create a pull request just sent the files in any way you can.
+
+## Android
+
+A single file needs to be translated: https://github.com/tinode/tindroid/app/src/main/res/values/strings.xml
+
+Create a new directory `values-XX` in [app/src/main/res](app/src/main/res), where `XX` is a two-letter [ISO-631-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code , optionally followed by a two letter [ISO 3166-1-alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) region code (preceded by lowercase r), for example `pt-rBR`: Brazilian Portuguese.
+
+Make a copy of the file with English strings, place it to the new directory. Translate all the strings not marked with `translatable="false"` (the strings with `translatable="false"` don't need to be included at all) then send a pull request with the new file. If you don't know how to create a pull request then just sent the file in any way you can.
+
+
+## iOS
+
+The following two files need to be translated: