diff --git a/README.md b/README.md index 3aaa080..23ff25f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +

KF3 Tranlsation Updater

+ This is a translation updater created for Vorked's KF3 Tranlsation project [KF3TL](https://github.com/Vorked/KF3TL) It provides a simple UI for updating the translation files for when new updates are published. @@ -10,6 +12,8 @@ Upon starting the game, if a new update is available, a button will appear at th Clicking the button will begin to download and extract the translation files (existing files will be overwritten!) +After the update, the game has to be restarted for the changes to take effect. This is a limitation of XUnity which loads translation files on startup. + If there are no new updates, or when the update finishes, the plugin disables itself and does not affect the game.

Build