diff --git a/CHANGELOG.md b/CHANGELOG.md
index d0d2f2a..059334c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -15,7 +15,7 @@
- Better focus keys in tree-view after edit
- Optimized internal data structure (io, cache, events)
- Adjusted compatibility matrix to 2020.3 - 2021.3
-- Updated dependencies
+- Updated dependencies and improved README file
## [1.5.1]
### Fixed
diff --git a/README.md b/README.md
index 5dd8911..d4676bb 100644
--- a/README.md
+++ b/README.md
@@ -6,29 +6,40 @@
[](https://paypal.me/marhalide)
-This is an easy plugin to manage internationalization for JSON or Resource-Bundle(Properties) based locale files.
-Most common use case is for translating Webapps or simple Java Applications. Translating large scale projects was never that easy with your favourite IDE!
+This is a plugin for easier management of translation files of projects that need to be translated into different languages. Translating large projects has never been so easy with your favorite IDE!
## Use Cases
-- Webapps: For example [Vue](https://vuejs.org/) with [vue-i18n](https://kazupon.github.io/vue-i18n/) or any other JSON translation file based technology
-- Java based Resource-Bundle
+- Webapps: [Vue](https://vuejs.org/) with [vue-i18n](https://kazupon.github.io/vue-i18n/), [React](https://reactjs.org/) or any other json based technology
+- Java projects based on Resource-Bundle's
+- Projects that uses yaml, json or properties as locale file base for internationalization
## Features
-- UI Tool Window with Table- and Tree-View representation
+- UI Tool Window which supports tree- or table-view
- Easily Add / Edit / Delete translations
-- Filter / Search function to hide irrelevant keys
-- Key completion and annotation inside editor
-- Configurable locales directory & preferred locale for ui presentation
-- Supports modularized (splitted) json files
-- Translation keys with missing definition for any locale will be displayed red
-- Quick edit any translation by right-click (IntelliJ Popup Action)
-- Quick delete any translation via DEL-Key
+- Filter function with full-text-search support
+- Editor Assistance: Key completion, annotation and referencing
+- Key sorting and nesting can be configured
+- Configurable locales directory & preferred locale for ui presentation
+- Missing language translations will be indicated red
+- Quick actions: right-click or DEL to edit or delete a translation
+- Automatically reloads translation data if any locale file was changed
## Screenshots
-
-
-
+
+
+
+
+
+
+
+## Supported IO Strategies (locale files)
+- Json: json files inside locales directory
+- Namespaced Json: Multiple json files per locale directory
+- Yaml: yml or yaml files inside locales directory
+- Properties: properties files inside locales directory
+
+If there are any files in the locales folder that should not be processed, they can be ignored with the Translation file pattern option.
## Installation
- Using IDE built-in plugin system:
@@ -45,8 +56,8 @@ Most common use case is for translating Webapps or simple Java Applications. Tra
- Install plugin. See **Installation** section
- Create a directory which will hold the locale files
- Create a file for each required locale (e.g de.json, en.json) Note: Each json file must at least define an empty section (e.g. **{}**)
-- Click on the **Settings** Action inside the Easy I18n Tool Window
-- Select the created directory (optional: define the preferred locale to view) and press Ok
+- Click on the **Settings** Action inside the EasyI18n Tool Window
+- Select the created directory (optional: define the preferred locale to view) and press **Ok**
- Translations can now be created / edited or deleted
Examples for the configuration can be found in the [/example](https://github.com/marhali/easy-i18n/tree/main/example) folder.
diff --git a/example/images/Completion.PNG b/example/images/Completion.PNG
deleted file mode 100644
index 239fd68..0000000
Binary files a/example/images/Completion.PNG and /dev/null differ
diff --git a/example/images/TableView.PNG b/example/images/TableView.PNG
deleted file mode 100644
index 878dfce..0000000
Binary files a/example/images/TableView.PNG and /dev/null differ
diff --git a/example/images/TreeView.PNG b/example/images/TreeView.PNG
deleted file mode 100644
index f0a7247..0000000
Binary files a/example/images/TreeView.PNG and /dev/null differ
diff --git a/example/images/key-annotation.PNG b/example/images/key-annotation.PNG
new file mode 100644
index 0000000..df0ca9a
Binary files /dev/null and b/example/images/key-annotation.PNG differ
diff --git a/example/images/key-completion.PNG b/example/images/key-completion.PNG
new file mode 100644
index 0000000..3b1bd01
Binary files /dev/null and b/example/images/key-completion.PNG differ
diff --git a/example/images/key-edit.PNG b/example/images/key-edit.PNG
new file mode 100644
index 0000000..d6ab6ef
Binary files /dev/null and b/example/images/key-edit.PNG differ
diff --git a/example/images/settings.PNG b/example/images/settings.PNG
new file mode 100644
index 0000000..29cf385
Binary files /dev/null and b/example/images/settings.PNG differ
diff --git a/example/images/table-view.PNG b/example/images/table-view.PNG
new file mode 100644
index 0000000..fc02213
Binary files /dev/null and b/example/images/table-view.PNG differ
diff --git a/example/images/tree-view.PNG b/example/images/tree-view.PNG
new file mode 100644
index 0000000..7bf34da
Binary files /dev/null and b/example/images/tree-view.PNG differ