Skip to content

Commit

Permalink
update readme(upload to npm)
Browse files Browse the repository at this point in the history
  • Loading branch information
moonyoulove committed Jun 1, 2024
1 parent 9c2cfe7 commit fe6aad9
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ npm install
```
Or install by npm directly:
```shell
npm install https://github.com/moonyoulove/translate-rpgmaker-plugin.git
npm install translate-rpgmaker-plugin
```
Or download single executable app from [release page](https://github.com/moonyoulove/translate-rpgmaker-plugin/releases/latest).

## Config
Go to project directory, rename *.env.example* to *.env* and fill it on demand.

If using executable binary, put *.env* in the same directory.
```shell
DEEPL_KEY=
AZURE_KEY=
Expand Down Expand Up @@ -65,6 +67,11 @@ Translate engine types:
manual
will generate txt file for manual translation (ex. website version of google translate, microsoft word, etc..)
```
Available languages:
1. [DeepL](https://developers.deepl.com/docs/resources/supported-languages)
3. [Azure Text Translation](https://learn.microsoft.com/en-us/azure/ai-services/translator/language-support)
3. [Google Cloud Translation](https://cloud.google.com/translate/docs/languages)

## Programming
```js
import translatePlugin from "translate-rpgmaker-plugin";
Expand Down
1 change: 1 addition & 0 deletions build.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ spinner.text = "Create configuration file";
const config = {
main: `${buildDir}/bundled-${path.basename(startJs)}`,
output: `${buildDir}/sea-prep.blob`,
disableExperimentalSEAWarning: true,
};
await write(`${buildDir}/sea-config.json`, JSON.stringify(config));

Expand Down

0 comments on commit fe6aad9

Please sign in to comment.