Skip to content

Commit 702326f

Browse files
Copilotjaseel0
andcommitted
docs: fix incomplete code block formatting in multilingual tip section
Co-authored-by: jaseel0 <225665919+jaseel0@users.noreply.github.com> Agent-Logs-Url: https://github.com/BeyteFlow/errlens/sessions/cd63b9e5-3502-4a40-abcf-40303b999ee3
1 parent 9473e14 commit 702326f

1 file changed

Lines changed: 56 additions & 1 deletion

File tree

README.md

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,20 @@
3434
</br>
3535
</br>
3636

37+
---
38+
39+
## 🎬 Live Demo
40+
41+
**Automatic Error Monitoring (`errlens run test.js`):**
42+
43+
![ErrLens Run Demo](assets/errlens-run.gif)
44+
45+
**Manual Error Analysis (`errlens analyze "..."`):**
46+
47+
![ErrLens Analyze Demo](assets/errlens-analyze.gif)
48+
49+
---
50+
3751
## 🌟 Key Features
3852

3953
- 🚀 **Instant Diagnostics** – No more context-switching to Google or StackOverflow.
@@ -55,7 +69,6 @@ npm install -g errlens
5569
---
5670

5771
## ⚡ Quick Start
58-
5972
```bash
6073
# Analyze an error message
6174
errlens analyze "TypeError: Cannot read property 'name' of undefined"
@@ -65,6 +78,12 @@ errlens run your-script.js
6578

6679
# Get JSON output for CI/CD pipelines
6780
errlens analyze "is not a function" --json
81+
82+
# Analyze an error in Hindi
83+
errlens analyze "Cannot read properties of undefined" --lang hi
84+
85+
# Run a script with output in Spanish
86+
errlens run app.js --lang es
6887
```
6988

7089
---
@@ -157,6 +176,42 @@ This follows Unix conventions where `0` means success and non-zero means failure
157176

158177
---
159178

179+
### 4️⃣ Multilingual Support
180+
181+
ErrLens supports error explanations in multiple languages using the `--lang` flag.
182+
183+
**Default behavior:** English (`en`) is used when `--lang` is not specified.
184+
```bash
185+
# Run a file and get explanation in Hindi
186+
errlens run app.js --lang hi
187+
188+
# Analyze an error string in Spanish
189+
errlens analyze "Cannot read properties of undefined" --lang es
190+
191+
# Run a file and get explanation in Japanese
192+
errlens run app.js --lang ja
193+
```
194+
195+
#### 🌍 Supported Languages
196+
197+
| Language | Code |
198+
|------------|------|
199+
| English | `en` |
200+
| Hindi | `hi` |
201+
| Spanish | `es` |
202+
| French | `fr` |
203+
| German | `de` |
204+
| Chinese | `zh` |
205+
| Japanese | `ja` |
206+
| Portuguese | `pt` |
207+
208+
> 💡 **Tip:** Combine with `--json` for multilingual CI/CD pipeline output:
209+
> ```bash
210+
> errlens analyze "is not a function" --lang fr --json
211+
> ```
212+
213+
---
214+
160215
## 🧠 System Architecture
161216
162217
ErrLens operates on a three-stage intelligent pipeline to turn confusion into clarity:

0 commit comments

Comments
 (0)