Merge branch 'main' of https://github.com/toolstack/gp-machine-translate

readme.md

@@ -1,17 +1,31 @@
-# GP Machine Translate
-A machine translate plugin for [GlotPress as a WordPress plugin](https://github.com/GlotPress/GlotPress-WP).
+# GP Machine Translate #
+**Contributors:** [gregross](https://profiles.wordpress.org/gregross/)  
+**Donate link:** http://toolstack.com/donate  
+**Plugin URI:** http://glot-o-matic.com/gp-machine-translate  
+**Author URI:** http://toolstack.com  
+**Tags:** glotpress, glotpress plugin, translate, google, bing, yandex, microsoft, transltr, deepl  
+**Requires at least:** 4.4  
+**Tested up to:** 6.4  
+**Stable tag:** 1.0  
+**License:** GPLv2  
+**License URI:** http://www.gnu.org/licenses/gpl-2.0.html  
 
-Five machine translation providers are supported (though only one at a time):
+A machine translate plugin for GlotPress as a WordPress plugin.
+
+## Description ##
+
+A machine translate plugin for [GlotPress as a WordPress plugin](https://github.com/GlotPress/GlotPress).
+
+Four machine translation providers are supported (though only one at a time):
 
 * DeepL (pay per character, Pro account required)
 * Google Translate (pay per character)
 * Microsoft Translator (free tier available)
-* translte.org (free)
 * Yandex.Translate (free but requires Yandex account)
 
 Note: This plugin assumes the source language is English as support for automated translation from other source languages is limited.
 
-## Configuration
+### Configuration ###
 
 Once you have installed GP Machine Translate, go to your WordPress admin screen and select "Settings > GP Machine Translate".
 
@@ -23,7 +37,7 @@ You will have three Fields to configure:
 
 You can select from five providers with some requiring the additional fields to be filled in.
 
-## DeepL
+### DeepL ###
 
 DeepL has a free tier that allows you to access the API for 500k characters per month.  Additional characters require a DeepL API Pro (aka paid) account.
 
@@ -33,7 +47,7 @@ DeepL has a free tier that allows you to access the API for 500k characters per
 
 Note also that DeepL allows for a maximum of 50 strings to be translated at once, so keep that in mind when doing bulk translations and only selected at most 50 strings.
 
-## Google
+### Google ###
 
 Google Translate requires an API key to function, to do this you must register with Google and provide a payment method.
 
@@ -43,7 +57,7 @@ Google Translate requires an API key to function, to do this you must register w
 
 The public access key is what you will use to configure GP Machine Translate with, either for all users or a specific user.
 
-## Microsoft Translator
+### Microsoft Translator ###
 
 Microsoft Translator requires an API key to function, to do this you must register with Microsoft.  Microsoft does have a free tier for translation, limited to 2 million characters a month so you do not need to provide payment details for this tier.
 
@@ -53,11 +67,11 @@ Microsoft has a walk through on how to subscribe to the Translator service here:
 
 You will need both the client secret and client id for it to function with GP Machine Translate.
 
-## transltr.org
+### transltr.org ###
 
 This service no longer exists and has been removed from the plugin.
 
-## Yandex.Translate
+### Yandex.Translate ###
 
 Yandex.Translate is a free service, however you must sign up to their service and adhere to their terms of service.  This includes providing a link back to the service for translated text.
 
@@ -69,15 +83,15 @@ To get an API key, follow the instructions here:
 
 [Powered by Yandex.Translate](http://translate.yandex.com/).
 
-## Setting the API key
+### Setting the API key ###
 
 To set the API key for all users, go to the WordPress Dashboard, then Settings, then "GP Machine Translate" and set the API key (and Client ID if required).
 
 To set if for a specific user, go to the users profile and scroll down to the "GP Machine Translate" section and set the API key (and Client ID if required).
 
 Note, if both a global and user API key are set, the user API key will override the global API key.
 
-## Supported Languages by Provider
+### Supported Languages by Provider ###
 
 | DeepL                 | Google Translate      | Microsoft Translator  | Yandex.Translate      |
 |-----------------------|-----------------------|-----------------------|-----------------------|