Merge pull request #68 from crydotsnake/task/adjust-readme

TASK: fix typos in README.md file

Author: mficzel

README.md

@@ -1,8 +1,8 @@
 # Sitegeist.LostInTranslation
 ## Automatic Translations for Neos via DeeplApi
 
-Documents and Contents are translated automatically once editors choose to "create and copy" a version in another language.
-The included DeeplService can be used for other purposes aswell.
+Documents and contents are translated automatically once editors choose to "create and copy" a version in another language.
+The included DeeplService can be used for other purposes as well.
 
 The development was a collaboration of Sitegeist and Code Q.
 
@@ -11,19 +11,19 @@ The development was a collaboration of Sitegeist and Code Q.
 * Martin Ficzel - ficzel@sitegeist.de
 * Felix Gradinaru - fg@codeq.at
 
-*The development and the public-releases of this package is generously sponsored
+*The development and the public releases of this package are generously sponsored
 by our employers http://www.sitegeist.de and http://www.codeq.at.*
 
 ## Installation
 
-Sitegeist.LostInTranslation is available via packagist. Run `composer require sitegeist/lostintranslation`.
+Sitegeist.LostInTranslation is available via Packagist. Run `composer require sitegeist/lostintranslation`.
 
-We use semantic-versioning so every breaking change will increase the major-version number.
+We use semantic versioning so every breaking change will increase the major version number.
 
 ## How it works
 
-By default all inline editable properties are translated using DeepL (see Setting `translateInlineEditables`).
-To include other `string` properties into the automatic translation the `options.automaticTranslation: true`
+By default, all inline editable properties are translated using DeepL (see setting `translateInlineEditables`).
+To include other `string` properties in the automatic translation, the `options.automaticTranslation: true`
 can be used in the property configuration. Also, you can disable automatic translation in general for certain node types
 by setting `options.automaticTranslation: false`.
 
@@ -58,8 +58,8 @@ Also, automatic translation for all types derived from `Neos.Neos:Node` is enabl
 
 ## Configuration
 
-This package needs an authenticationKey for the DeeplL Api from https://www.deepl.com/pro-api.
-There are free plans that support a limited number but for productive use we recommend using a payed plan.
+This package needs an authenticationKey for the DeepL API from https://www.deepl.com/pro-api.
+There are free plans that support a limited number, but for productive use we recommend using a paid plan.
 
 ```yaml
 Sitegeist:
@@ -68,7 +68,7 @@ Sitegeist:
       authenticationKey: '.........................'
 ```
 
-The translation of nodes can is configured via settings:
+The translation of nodes is configured via settings:
 
 ```yaml
 Sitegeist:
@@ -82,8 +82,8 @@ Sitegeist:
       #
       # Translate all inline editable fields without further configuration.
       #
-      # If this is disabled iline editables can be configured for translation by setting
-      # `options.translateOnAdoption: true` for each property seperatly
+      # If this is disabled, inline editables can be configured for translation by setting
+      # `options.translateOnAdoption: true` for each property separately
       #
       translateInlineEditables: true
 
@@ -93,7 +93,7 @@ Sitegeist:
       languageDimensionName: 'language'
 ```
 
-If a preset of the language dimension uses a locale identifier that is not compatible with DeepL the deeplLanguage can
+If a preset of the language dimension uses a locale identifier that is not compatible with DeepL, the `deeplLanguage` can
 be configured explicitly for this preset via `options.deeplLanguage`.
 
 ```yaml
@@ -103,7 +103,7 @@ Neos:
       'language':
 
         #
-        # The `defaultPreset` marks the source of for all translations whith mode `sync`
+        # The `defaultPreset` marks the source for all translations with mode `sync`
         #
         label: 'Language'
         default: 'en'
@@ -112,8 +112,8 @@ Neos:
         presets:
 
           #
-          # English has to be configured differently for source and target as deeply requires so,
-          # The source and target are seperated by a `:`
+          # English has to be configured differently for source and target as DeepL requires so,
+          # the source and target are separated by a `:`
           #
           'en':
             label: 'English'
@@ -123,7 +123,7 @@ Neos:
               deeplLanguage: 'EN:EN-GB'
 
           #
-          # Danish uses a different locale identifier then DeepL so the `deeplLanguage` has to be configured explicitly
+          # Danish uses a different locale identifier than DeepL, so the `deeplLanguage` has to be configured explicitly
           #
           'dk':
             label: 'Dansk'
@@ -133,15 +133,15 @@ Neos:
               deeplLanguage: 'DA'
 
           #
-          # For German the dimension value de is used in uppercase 
+          # For German, the dimension value de is used in uppercase
           #
           'de':
-            label: 'Bayrisch'
+            label: 'Deutsch'
             values: ['de']
-            uriSegment: 'de'          
+            uriSegment: 'de'
 
           #
-          # The bavarian language is not supported by DeepL and is disabled
+          # The Bavarian language is not supported by DeepL and is disabled
           #
           'de_bar':
             label: 'Bayrisch'
@@ -154,7 +154,7 @@ Neos:
 ### Ignoring Terms
 
 You can define terms that should be ignored by DeepL in the configuration.
-The terms will are evaluated case-insensitive when searching for them, however
+The terms are evaluated case-insensitively when searching for them, however
 they will always be replaced with their actual occurrence.
 
 This is how an example configuration could look like:
@@ -171,9 +171,10 @@ Sitegeist:
 
 ## Eel Helper
 
-The package also provides two Eel Helper to translate texts in Fusion.
+The package also provides two Eel helpers to translate texts in Fusion.
 
-**:warning: Every one of these Eel helpers make an individual request to DeepL.** Thus having many of them on one page can significantly slow down the performance for if the page is uncached.
+**:warning: Every one of these Eel helpers makes an individual request to DeepL.**
+Thus, having many of them on one page can significantly slow down the performance if the page is uncached.
 :bulb: Only use while the [translation cache](#translation-cache) is enabled!
 
 To translate a single text you can use:
@@ -195,7 +196,7 @@ ${Sitegeist.LostInTranslation.translate(['Hello world!', 'My name is...'], 'de',
 ### Translation Cache
 
 The plugin includes a translation cache for the DeepL API that stores the individual text parts
-and their translated result for up to one week.
+and their translated results for up to one week.
 By default, the cache is enabled. To disable the cache, you need to set the following setting:
 
 ```yaml
@@ -207,7 +208,9 @@ Sitegeist:
 
 ## Performance
 
-For every translated node a single request is made to the DeepL API. This can lead to significant delay when Documents with lots of nodes are translated. It is likely that future versions will improve this.
+For every translated node, a single request is made to the DeepL API.
+This can lead to significant delay when documents with lots of nodes are translated.
+It is likely that future versions will improve this.
 
 ## Contribution
 
@@ -217,8 +220,8 @@ We will gladly accept contributions. Please send us pull requests.
 
 ### 2.0.0
 
-* The preset option `translationStrategy` was introduced. There are now two auto-translation strategies
+* The preset option `translationStrategy` was introduced. There are now two auto-translation strategies:
   * Strategy `once` will auto-translate the node once "on adoption", i.e. the editor switches to a different language dimension
   * Strategy `sync` will auto-translate and sync the node every time a node is updated in the default preset language
-* The node setting `options.translateOnAdoption` as been renamed to `options.automaticTranslation`
+* The node setting `options.translateOnAdoption` has been renamed to `options.automaticTranslation`
 * The new node option `options.automaticTranslation` was introduced