Skip to content

docs: fix unclosed code block in multilingual tip blockquote #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
naheel0 merged 2 commits into from
Mar 25, 2026
+56 −1
Merged

docs: fix unclosed code block in multilingual tip blockquote #63

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9473e14
Initial plan
Copilot Mar 25, 2026
702326f
docs: fix incomplete code block formatting in multilingual tip section
Copilot Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 56 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,20 @@
</br>
</br>

---

## 🎬 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.
Expand All @@ -55,7 +69,6 @@ npm install -g errlens
---

## ⚡ Quick Start

```bash
# Analyze an error message
errlens analyze "TypeError: Cannot read property 'name' of undefined"
Expand All @@ -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
```

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

---

### 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

ErrLens operates on a three-stage intelligent pipeline to turn confusion into clarity:
Expand Down
Loading