Skip to content

Commit b29cbee

Browse files
committed
chore: readme update for yaml updates
1 parent b7348a4 commit b29cbee

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<img src="https://i.hizliresim.com/stgrebn.png" alt="jsontt logo" width="150" />
33
</p>
44

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

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

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

2525
### Types of usages 👀
2626

@@ -48,6 +48,8 @@ npm i -g @parvineyvazov/json-translator
4848

4949
```bash
5050
jsontt <your/path/to/file.json>
51+
or
52+
jsontt <your/path/to/file.yaml/yml>
5153
```
5254

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

5759
## Arguments
5860

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

6264
## Options
6365

64-
- -V, --version output the version number
65-
- -T, --translator <Translator> specify translation service (choices: "google", "libre", "argos", "bing")
66-
- -f, --from <Language> the translate language from it, e.g., --from en
67-
- -t, --to <Languages...> the Languages to translate into, e.g., --to ar fr zh-CN
68-
- -n, --name the name of the output file (optional), e.g., --name newFileName
69-
- -h, --help display help for command
66+
- -V, --version output the version number
67+
- -T, --translator <Translator> specify translation service (choices: "google", "libre", "argos", "bing")
68+
- -f, --from <Language> the translate language from it, e.g., --from en
69+
- -t, --to <Languages...> the Languages to translate into, e.g., --to ar fr zh-CN
70+
- -n, --name the name of the output file (optional), e.g., --name newFileName
71+
- -h, --help display help for command
72+
7073
## Examples
7174

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

432435
## **7. CLI commands**
433436

434-
- translate
437+
- translate (json/yaml)
435438

436439
```bash
437440
jsontt file.json
@@ -455,7 +458,7 @@ jsontt "C:\folder1\folder\en.json"
455458
jsontt file.json proxy.txt
456459
```
457460

458-
Result will be in the same folder as the original JSON file.
461+
Result will be in the same folder as the original JSON/YAML file.
459462

460463
<br>
461464

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

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

581+
:heavy_check_mark: YAML file Translate
582+
578583
- [ ] Libre Translate option (in code package)
579584

580585
- [ ] Argos Translate option (in code package)

0 commit comments

Comments
 (0)