Skip to content

Commit 211540e

Browse files
committed
chore: 📝 update Readme
1 parent 0e682ae commit 211540e

1 file changed

Lines changed: 75 additions & 3 deletions

File tree

README.md

Lines changed: 75 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,50 @@ Use `la` as the level to display all levels:
3535
dummie strucview --level la
3636
```
3737

38+
Example output:
39+
40+
```
41+
face-recognition-server
42+
├── __pycache__
43+
│ ├── api.cpython-312.pyc
44+
│ ├── db.cpython-312.pyc
45+
│ ├── main.cpython-312.pyc
46+
└── ws.cpython-312.pyc
47+
├── .git
48+
│ └── [...]
49+
├── static
50+
│ ├── index.html
51+
│ ├── script.js
52+
└── style.css
53+
├── test-app
54+
│ ├── .github
55+
│ │ └── [...]
56+
│ ├── node_modules
57+
│ │ └── [...]
58+
│ ├── public
59+
│ │ └── [...]
60+
└── src
61+
├── tests
62+
│ ├── __pycache__
63+
│ ├── images
64+
└── test_main.py
65+
├── venv
66+
│ ├── Include
67+
│ ├── Lib
68+
│ ├── Scripts
69+
└── pyvenv.cfg
70+
├── .env
71+
├── .gitignore
72+
├── api.py
73+
├── db.py
74+
├── main.py
75+
├── README.md
76+
├── requirements.txt
77+
└── ws.py
78+
```
79+
80+
The tool automatically collapses large directories and shows a directory-first structure, making it easy to understand project layouts.
81+
3882
### translate
3983

4084
Translate text between languages using Google Translate API with a Puppeteer fallback mechanism.
@@ -44,14 +88,27 @@ dummie translate <text> [options]
4488
```
4589

4690
Options:
47-
- `-f, --from <lang>`: Source language code (default: "auto")
48-
- `-t, --to <lang>`: Target language code (default: "en")
91+
- `-f, --from <lang>`: Source language code (default: "en")
92+
- `-t, --to <lang>`: Target language code (default: "vi")
93+
94+
Examples:
4995

50-
Example:
5196
```bash
97+
# From French to English
5298
dummie translate "Bonjour le monde" --from fr --to en
99+
# Output: Hello world
100+
101+
# From English to French
102+
dummie translate "Hello, how are you today?" --from en --to fr
103+
# Output: Bonjour, comment vas-tu aujourd'hui?
104+
105+
# From Vietnamese to English
106+
dummie translate "Vô lý" --from vi --to en
107+
# Output: Unreasonable
53108
```
54109

110+
The translation feature uses a reliable HTTP API first and falls back to a browser-based method if the API fails, ensuring robust translations even during API limitations.
111+
55112
### info
56113

57114
Display information about your system and environment.
@@ -85,6 +142,17 @@ dummie browser-detect
85142

86143
This command helps you configure the Chrome browser path for the translation feature's fallback mechanism. It will scan common installation locations and provide instructions for setting the `CHROME_PATH` environment variable.
87144

145+
Example output:
146+
147+
```
148+
Detecting browsers for translation feature...
149+
✅ Found Chrome at: C:/Program Files/Google/Chrome/Application/chrome.exe
150+
151+
To use this browser for translations, set the CHROME_PATH environment variable:
152+
153+
setx CHROME_PATH "C:/Program Files/Google/Chrome/Application/chrome.exe"
154+
```
155+
88156
## Global Options
89157

90158
These options are available with all commands:
@@ -105,3 +173,7 @@ These options are available with all commands:
105173
## License
106174

107175
MIT © [Doan Nam Son](https://github.com/sondoannam)
176+
177+
## Issues
178+
179+
Feel free to open issues for this pkg.

0 commit comments

Comments
 (0)