Skip to content

Commit

Permalink
chore: readme update for yaml updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ParvinEyvazov committed Dec 9, 2023
1 parent b7348a4 commit b29cbee
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<img src="https://i.hizliresim.com/stgrebn.png" alt="jsontt logo" width="150" />
</p>

# <p align="center"> **🚀 FREE JSON TRANSLATOR 🆓** </p>
# <p align="center"> **🚀 FREE JSON/YAML TRANSLATOR 🆓** </p>

<p align="center">
<a href="https://img.shields.io/npm/dt/@parvineyvazov/json-translator?label=npm%20downloads">
Expand All @@ -20,7 +20,7 @@
</a>
</p>

This package will provide you to translate your JSON files or objects into different languages FREE.
This package will provide you to translate your JSON/YAML files or JSON objects into different languages FREE.

### Types of usages 👀

Expand Down Expand Up @@ -48,6 +48,8 @@ npm i -g @parvineyvazov/json-translator

```bash
jsontt <your/path/to/file.json>
or
jsontt <your/path/to/file.yaml/yml>
```

<p align="center" >
Expand All @@ -56,17 +58,18 @@ jsontt <your/path/to/file.json>

## Arguments

- `[path]`: Required JSON file path `<your/path/to/file.json>`
- `[path]`: Required JSON/YAML file path `<your/path/to/file.json>`
- `[path]`: optional proxy list txt file path `<your/path/to/proxy_list.txt>`

## Options

- -V, --version output the version number
- -T, --translator <Translator> specify translation service (choices: "google", "libre", "argos", "bing")
- -f, --from <Language> the translate language from it, e.g., --from en
- -t, --to <Languages...> the Languages to translate into, e.g., --to ar fr zh-CN
- -n, --name the name of the output file (optional), e.g., --name newFileName
- -h, --help display help for command
- -V, --version output the version number
- -T, --translator <Translator> specify translation service (choices: "google", "libre", "argos", "bing")
- -f, --from <Language> the translate language from it, e.g., --from en
- -t, --to <Languages...> the Languages to translate into, e.g., --to ar fr zh-CN
- -n, --name the name of the output file (optional), e.g., --name newFileName
- -h, --help display help for command

## Examples

Translate a JSON file using Google Translate:
Expand Down Expand Up @@ -431,7 +434,7 @@ To ignore words on translation use `{{word}}` OR `{word}` style on your object.

## **7. CLI commands**

- translate
- translate (json/yaml)

```bash
jsontt file.json
Expand All @@ -455,7 +458,7 @@ jsontt "C:\folder1\folder\en.json"
jsontt file.json proxy.txt
```

Result will be in the same folder as the original JSON file.
Result will be in the same folder as the original JSON/YAML file.

<br>

Expand Down Expand Up @@ -575,6 +578,8 @@ Make sure your terminal has admin access while running these commands to prevent

:heavy_check_mark: Define output file names on cli (optional command for cli)

:heavy_check_mark: YAML file Translate

- [ ] Libre Translate option (in code package)

- [ ] Argos Translate option (in code package)
Expand Down

0 comments on commit b29cbee

Please sign in to comment.