From 7c42d8f081accbb1d98a0a21d658e8ac3746676d Mon Sep 17 00:00:00 2001 From: io42630 Date: Sun, 26 Jun 2022 21:21:33 +0200 Subject: [PATCH] + update doc --- README-ua.md | 33 +++++++++++++++++++++++++++++++ README.md | 56 +++++++++++++++++++++------------------------------- 2 files changed, 56 insertions(+), 33 deletions(-) create mode 100644 README-ua.md diff --git a/README-ua.md b/README-ua.md new file mode 100644 index 0000000..f3e64bd --- /dev/null +++ b/README-ua.md @@ -0,0 +1,33 @@ +# Translate ReeBot + +### Про +* Вбудовані переклади Telegram через DeepL і Google. +* Підтримує `de`, `en`, `ua`, `es`, `fr`, `it`. +* Максимум ~256 символів на запит. + +### Як використовувати +* **Налаштування** + * Перейдіть до користувача Telegram `@translate_reebot`. + * Введіть `/start`. +* **Використання** + * Перейдіть до будь-якого чату. + * Введіть `@translate_reebot hello,,`. + * Замініть "привіт" текстом на ваш вибір. + * (`,,` – це команда "відправити запит") + * Це перекладається як `de`. + * Також можна ввести `@translate_reebot hello,,ua`. + * Буде перекладено на вказану мову. +* **Вирішення проблем** + * Це трохи експериментально - якщо перестане працювати, будь ласка, повідомте мене. + +
+
+
+ +### Кава +* Переклад порівняно дешевий (256 символів ~ CHF 0,005). +* Якщо ви все ще хочете підтримувати програму або запропонувати нові функції: https://ko-fi.com/io42630 + +### Особлива подяка +* https://github.com/baitun/node-telegram-translate-bot +* https://github.com/yagop/node-telegram-bot-api diff --git a/README.md b/README.md index 86d7bdc..99a8a87 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,35 @@ # Translate ReeBot ### About -* Uses DeepL for Telegram inline translations to `de`, `en` and `ru` (there is no `ua` in DeepL). - +* Telegram inline translations via DeepL and Google. +* Supports `de`, `en` , `ua`, `es`, `fr`, `it`. +* Max ~256 characters per query. ### How To Use -* **setup** - * go to the Telegram user `@translate_reebot` - * type `/start` -* **usage** - * go to any chat - * type `@translate_reebot hello,,` - * replace `hello` with text of your choice. +* **Setup** + * Go to the Telegram user `@translate_reebot`. + * Type `/start`. +* **Usage** + * Go to any chat. + * Type `@translate_reebot hello,,`. + * Replace `hello` with text of your choice. * (`,,` is the "send query" command) - * this will translate to `de` - * can also type `@translate_reebot hello,,ru` or `@translate_reebot hello,,en` - * this will translate to `ru` or `en` - * for next use should be able to type `@tr` and `TAB` - * if it stops working, write me at ivan ; olexyn ; com. - -### Как использовать -* **установка** - * перейти к пользователю Telegram `@translate_reebot` - * введите `/start` -* **использование** - * зайдите в любой чат - * введите `@translate_reebot hello,,` - * замените `hello` на текст по вашему выбору. - * (`,,` - это команда "отправить запрос") - * это будет переведено как `de` - * можно также ввести `@translate_reebot hello,,ru` или `@translate_reebot hello,,en` - * это переведет на `ru` или `en`. - * для следующего использования должна быть возможность набирать `@tr` и `TAB` - * если он перестанет работать, напишите мне по адресу ivan ; olexyn ; com. + * This will translate to `de`. + * Can also type `@translate_reebot hello,,ua`. + * This will translate to the specified language. +* **Troubleshooting** + * It is somewhat experimental - if it stops working, please notify me. -### How To Run -* enter API-keys into `keys-template.json`, then rename to `keys.json`. -* see `Dockerfile` -* also, suggested to use separate bot for testing. +
+
+
+### Coffee +* Translating is comparably cheap (256 chars ~ CHF 0.005). +* If you still want to support the app, or suggest new features: https://ko-fi.com/io42630 ### Special Thanks * https://github.com/baitun/node-telegram-translate-bot * https://github.com/yagop/node-telegram-bot-api + +