diff --git a/README.md b/README.md index 1fac994..b5aa0ef 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,10 @@ 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. - -![Tree View](https://raw.githubusercontent.com/marhali/easy-i18n/main/example/images/TreeView.PNG "Tree View") -![Table View](https://raw.githubusercontent.com/marhali/easy-i18n/main/example/images/TableView.PNG "Table View") +Most common use case is for translating Webapps or simple Java Applications. Translating large scale projects was never that easy with your favourite IDE! ## Use Cases -- Webapps: [Vue](https://vuejs.org/) with [vue-i18n](https://kazupon.github.io/vue-i18n/) or any other JSON translation file based technology +- 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 ## Features @@ -32,18 +29,14 @@ Most common use case is for translating Webapps or simple Java Applications. - 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 - -## Configuration -- 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 -- Translations can now be created / edited or deleted -## Installation +## Screenshots +![Tree View](https://raw.githubusercontent.com/marhali/easy-i18n/main/example/images/TreeView.PNG "Tree View") +![Table View](https://raw.githubusercontent.com/marhali/easy-i18n/main/example/images/TableView.PNG "Table View") + +## Installation - Using IDE built-in plugin system: Settings/Preferences > Plugins > Marketplace > Search for "easy-i18n" > @@ -54,6 +47,13 @@ Most common use case is for translating Webapps or simple Java Applications. Download the [latest release](https://github.com/marhali/easy-i18n/releases/latest) and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk... +## Configuration +- 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 +- Translations can now be created / edited or deleted --- Plugin based on the [IntelliJ Platform Plugin Template][template].