Skip to content

Commit a82121e

Browse files
authored
Merge pull request #61 from mahek395/main
docs: add GIF demo to README for better visualization
2 parents 38979ed + 2d10451 commit a82121e

3 files 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
---
@@ -155,6 +174,42 @@ Exit codes (useful for CI):
155174

156175
This follows Unix conventions where `0` means success and non-zero means failure. If you prefer success-on-detection in CI, invert the check in your pipeline logic (for example, treat exit code `1` from `analyze <errorString>` as a pass condition).
157176

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

assets/errlens-analyze.gif

32.6 KB
Loading

assets/errlens-run.gif

75.7 KB
Loading

0 commit comments

Comments
 (0)