Skip to content

Commit

Permalink
Fix README file
Browse files Browse the repository at this point in the history
  • Loading branch information
@fabasoad
fabasoad committed Dec 20, 2020
1 parent 3f47f0d commit a2864cf
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .vscode/settings.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
"Noite",
"UNSECURE",
"apim",
"brainfuck",
"camelcase",
"canadacentral",
"funtranslations",
"issuehunt",
"lcov",
Expand Down
15 changes: 8 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,12 +95,13 @@ Identifier is `funtranslations`.

## Inputs

| Name | Required | Description | Default | Possible values |
|----------|----------|--------------------------------------------------------------------------------------------------|---------|-------------------------------------------------------------------|
| source | Yes | Can be text or path to the file for translation. | | _<Path>_,_<String>_ |
| provider | Yes | Provider identifier | | [microsoft](#microsoft), [mymemory](#mymemory), [yandex](#yandex) |
| api_key | No | API key that should be used for chosen [provider](#providers) | null |_<String>_ |
| lang | Yes | The translation direction. Should be one of the option proposed by chosen [provider](#providers) | | _<String>_ |
| Name | Required | Description | Default | Possible values |
|--------------------------|----------|--------------------------------------------------------------------------------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------|
| source | Yes | Can be text or path to the file for translation | | _<Path>_,_<String>_ |
| provider | Yes | Provider identifier | | [linguatools](#linguatools), [microsoft](#microsoft), [mymemory](#mymemory), [yandex](#yandex), [funtranslations](#funtranslations) |
| api_key | No | API key that should be used for chosen [provider](#providers) | | |
| api_additional_parameter | No | Additional parameter for the API. eg the region for Microsoft: `canadacentral` | `null` | _<String>_ |
| lang | Yes | The translation direction. Should be one of the option proposed by chosen [provider](#providers) | | _<String>_ |

## Outputs

Expand Down Expand Up @@ -136,4 +137,4 @@ jobs:

### Result

![Result](https://github.com/raw/fabasoad/translation-action/main/screenshots/screenshot-yandex-result.png)
![Result](screenshots/screenshot-yandex-result.png)

0 comments on commit a2864cf

Please sign in to comment.