Generate Changelog and update README
This commit is contained in:
parent
7aff107d13
commit
c07d1c0fbd
13
CHANGELOG.md
13
CHANGELOG.md
@ -2,6 +2,17 @@
|
||||
|
||||
# easy-i18n Changelog
|
||||
|
||||
## [Unreleased]
|
||||
## [1.0] - 2021-03-14 (release)
|
||||
### Added
|
||||
- Support for JSON and Resource-Bundle(Properties) based locale files
|
||||
- UI Tool Window with Table- and Tree-View representation
|
||||
- Add / Edit / Delete functions
|
||||
- Search function to filter visible keys
|
||||
- Quick edit via right-click on any key
|
||||
- Quick edit via DEL-Key on any key
|
||||
- Locales directory / preferred locale can be configured via Settings Dialog
|
||||
- I18n keys with one or more missing locale translation will be show as red
|
||||
- Initial scaffold created from [IntelliJ Platform Plugin Template](https://github.com/JetBrains/intellij-platform-plugin-template)
|
||||
|
||||
### Changed
|
||||
- README.md
|
27
README.md
27
README.md
@ -14,11 +14,32 @@
|
||||
- [ ] Click the <kbd>Watch</kbd> button on the top of the [IntelliJ Platform Plugin Template][template] to be notified about releases containing new features and fixes.
|
||||
|
||||
<!-- Plugin description -->
|
||||
This Fancy IntelliJ Platform Plugin is going to be your implementation of the brilliant ideas that you have.
|
||||
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.
|
||||
|
||||
This specific section is a source for the [plugin.xml](/src/main/resources/META-INF/plugin.xml) file which will be extracted by the [Gradle](/build.gradle.kts) during the build process.
|
||||

|
||||

|
||||
|
||||
To keep everything working, do not remove `<!-- ... -->` sections.
|
||||
## Use Cases
|
||||
- Webapps: [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
|
||||
- UI Tool Window with Table- and Tree-View representation
|
||||
- Easily Add / Edit / Delete translations
|
||||
- Filter / Search function to hide irrelevant keys
|
||||
- Configurable locales directory & preferred locale for ui presentation
|
||||
- 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 <kbd>DEL</kbd>-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
|
||||
<!-- Plugin description end -->
|
||||
|
||||
## Installation
|
||||
|
BIN
example/images/TableView.PNG
Normal file
BIN
example/images/TableView.PNG
Normal file
Binary file not shown.
After Width: | Height: | Size: 9.0 KiB |
BIN
example/images/TreeView.PNG
Normal file
BIN
example/images/TreeView.PNG
Normal file
Binary file not shown.
After Width: | Height: | Size: 9.2 KiB |
@ -3,7 +3,7 @@
|
||||
|
||||
pluginGroup = com.github.marhali.easyi18n
|
||||
pluginName = easy-i18n
|
||||
pluginVersion = 0.0.1
|
||||
pluginVersion = 1.0
|
||||
pluginSinceBuild = 202
|
||||
pluginUntilBuild = 203.*
|
||||
# Plugin Verifier integration -> https://github.com/JetBrains/gradle-intellij-plugin#plugin-verifier-dsl
|
||||
|
Loading…
x
Reference in New Issue
Block a user