diff --git a/README.md b/README.md index 6df921d..a117807 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,20 @@

+--- + +## 🎬 Live Demo + +**Automatic Error Monitoring (`errlens run test.js`):** + +![ErrLens Run Demo](assets/errlens-run.gif) + +**Manual Error Analysis (`errlens analyze "..."`):** + +![ErrLens Analyze Demo](assets/errlens-analyze.gif) + +--- + ## 🌟 Key Features - 🚀 **Instant Diagnostics** – No more context-switching to Google or StackOverflow. @@ -55,7 +69,6 @@ npm install -g errlens --- ## ⚡ Quick Start - ```bash # Analyze an error message errlens analyze "TypeError: Cannot read property 'name' of undefined" @@ -65,6 +78,12 @@ errlens run your-script.js # Get JSON output for CI/CD pipelines errlens analyze "is not a function" --json + +# Analyze an error in Hindi +errlens analyze "Cannot read properties of undefined" --lang hi + +# Run a script with output in Spanish +errlens run app.js --lang es ``` --- @@ -155,6 +174,42 @@ Exit codes (useful for CI): 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 ` as a pass condition). +--- +--- + +### 4️⃣ Multilingual Support + +ErrLens supports error explanations in multiple languages using the `--lang` flag. + +**Default behavior:** English (`en`) is used when `--lang` is not specified. +```bash +# Run a file and get explanation in Hindi +errlens run app.js --lang hi + +# Analyze an error string in Spanish +errlens analyze "Cannot read properties of undefined" --lang es + +# Run a file and get explanation in Japanese +errlens run app.js --lang ja +``` + +#### 🌍 Supported Languages + +| Language | Code | +|------------|------| +| English | `en` | +| Hindi | `hi` | +| Spanish | `es` | +| French | `fr` | +| German | `de` | +| Chinese | `zh` | +| Japanese | `ja` | +| Portuguese | `pt` | + +> 💡 **Tip:** Combine with `--json` for multilingual CI/CD pipeline output: +> ```bash +> errlens analyze "is not a function" --lang fr --json +--- --- ## 🧠 System Architecture diff --git a/assets/errlens-analyze.gif b/assets/errlens-analyze.gif new file mode 100644 index 0000000..6e99b3e Binary files /dev/null and b/assets/errlens-analyze.gif differ diff --git a/assets/errlens-run.gif b/assets/errlens-run.gif new file mode 100644 index 0000000..40f5cef Binary files /dev/null and b/assets/errlens-run.gif differ