xcstrings-cli 2.4.0 → 2.5.1

package/README.md

@@ -266,6 +266,53 @@ These are the settings you can specify in the config file:
     * `skip`: Only add translations for languages included in the `xcs languages` output. (Default)
     * `include`: Add translations even when they are not recognized by the Xcode project or xcs language list.
 
+## Practical use cases
+
+### Case 1: Translate all missing strings using LLM
+
+Suppose you have a xcstrings file and want to add Japanese and Simplified Chinese translations generated by LLM.
+
+Firstly, list the strings missing those languages:
+
+```bash
+xcs strings --languages en --missing-languages ja zh-Hans
+# closeAction:
+#   en: "Close"
+# detailsAction:
+#   en: "Details"
+```
+
+Then, copy the output and use it as a prompt for the LLM to generate translations. We offer [xcstrings-cli Helper](https://chatgpt.com/g/g-69365945f8bc8191be3146f880238957-xcstrings-cli-helper), a Custom GPT that can help you generate translations in the form of an `xcs add` command. The prompt could be like this:
+
+```
+closeAction:
+  en: "Close"
+detailsAction:
+  en: "Details"
+
+Languages: ja, zh-Hans
+No comments needed.
+```
+
+Then the Custom GPT will generate an `xcs add` command like this:
+
+```bash
+xcs add --strings << EOF
+closeAction:
+    translations:
+        en: Close
+        ja: 閉じる
+        zh-Hans: 关闭
+detailsAction:
+    translations:
+        en: Details
+        ja: 詳細
+        zh-Hans: 详情
+EOF
+```
+
+Finally, copy the generated command and run it in your terminal to add the translations to your xcstrings file.
+
 ## Q&A
 
 **Q: Strings are not being added for some languages. Why?**