Add transliteration

README.md

@@ -12,6 +12,7 @@
 ### Features
 
 - Notification relay
+- Notificstion transliteration
 - Music control
 - Get info from watch (HRM, Battery level, Firmware version)
 - Set current time
@@ -36,6 +37,40 @@ The various request types and their data requirements can be seen in `internal/t
 
 ---
 
+### Transliteration
+
+Since the PineTime does not have enough space to store all unicode glyphs, it only stores the ASCII space and Cyrillic. Therefore, this daemon can transliterate unsupported characters into supported ones. Since some languages have different transliterations, the maps to be used must be specified in the config. Here are the available maps:
+
+- eASCII
+- Scandinavian
+- German
+- Hebrew
+- Greek
+- Russian
+- Ukranian
+- Arabic
+- Farsi
+- Polish
+- Lithuanian
+- Estonian
+- Icelandic
+- Czeck
+- French
+- Armenian
+- Emoji
+
+Place the desired map names in an array as `notifs.translit.maps.use`. They will be evaluated in order. You can also put custom transliterations in `notifs.translit.maps.custom`. These take priority over any other maps. The `notifs.translit.maps` config section should look like this:
+
+```toml
+[notifs.translit.maps]
+    use = ["eASCII", "Russian", "Emoji"]
+    custom = [
+        "test", "replaced"
+    ]
+```
+
+---
+
 ### `itctl`
 
 This daemon comes with a binary called `itctl` which uses the socket to control the daemon from the command line. As such, it can be scripted using bash.