Update README.md to enhance installation instructions and add usage examples

Author: koxudaxi

README.md

@@ -3,6 +3,15 @@
 Intelligent syntax highlighting and validation for Python template strings (PEP 750).
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![VSCode Marketplace](https://img.shields.io/visual-studio-marketplace/v/koxudaxi.t-linter.svg)](https://marketplace.visualstudio.com/items?itemName=koxudaxi.t-linter)
+[![PyPI](https://img.shields.io/pypi/v/t-linter.svg)](https://pypi.org/project/t-linter/)
+
+## Overview
+
+t-linter provides intelligent syntax highlighting and linting for Python template strings (PEP 750) through multiple distribution channels:
+
+- **🔧 Command-line tool**: Install via PyPI (`pip install t-linter`) for direct CLI usage and LSP server
+- **🎨 VSCode Extension**: Install from the Visual Studio Code Marketplace for seamless editor integration
 
 ## Features
 
@@ -13,33 +22,135 @@ Intelligent syntax highlighting and validation for Python template strings (PEP
 
 ## Installation
 
-Install using pip:
+### Option 1: VSCode Extension (Recommended for VSCode users)
 
+**Step 1: Install the t-linter binary**
+First, install the language server via PyPI:
 ```bash
 pip install t-linter
 ```
 
-## Usage
+**Step 2: Install the VSCode extension**
+Install the extension from the Visual Studio Code Marketplace:
 
-Run the language server:
+1. Open VSCode
+2. Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
+3. Search for "t-linter"
+4. Click Install on "T-Linter - Python Template Strings Highlighter & Linter" by koxudaxi
 
-```bash
-t-linter lsp
-```
+**Step 3: Configure the server path (if needed)**
+If t-linter is not in your PATH, configure the server path in VSCode settings:
+
+1. **Find your t-linter path** by running in terminal:
+   ```bash
+   which t-linter     # macOS/Linux
+   where t-linter     # Windows
+   ```
+
+2. Open VSCode Settings (Ctrl+, / Cmd+,)
+3. Search for "t-linter.serverPath"
+4. Set the full path to your t-linter executable:
+   - **Windows**: `C:\Users\YourName\AppData\Local\Programs\Python\Python3xx\Scripts\t-linter.exe`
+   - **macOS**: `/opt/homebrew/bin/t-linter` or `/usr/local/bin/t-linter`
+   - **Linux**: `/home/yourname/.local/bin/t-linter` or `/usr/local/bin/t-linter`
 
-Check files:
+**[→ Install from VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=koxudaxi.t-linter)**
+
+### Option 2: PyPI Package Only (CLI tool and LSP server)
+
+For command-line usage or integration with other editors, install only the PyPI package:
 
 ```bash
-t-linter check file.py
+pip install t-linter
 ```
 
-## Development
+This provides the `t-linter` command-line tool and LSP server without the VSCode extension.
 
-For development, you can also build from source:
+**[→ View on PyPI](https://pypi.org/project/t-linter/)**
+
+### Option 3: Build from Source
+
+For development or bleeding-edge features:
 
 ```bash
 git clone https://github.com/koxudaxi/t-linter
 cd t-linter
 cargo install --path crates/t-linter
 ```
 
+## Usage
+
+### VSCode Extension
+After installing both the PyPI package and VSCode extension, t-linter will automatically provide syntax highlighting for Python template strings. 
+
+**Troubleshooting**: If syntax highlighting doesn't work:
+1. Ensure `t-linter` is installed: Run `t-linter --version` in terminal
+2. Check the server path in VSCode settings: `t-linter.serverPath`
+3. Restart VSCode after making changes
+
+### Command Line Interface
+If you installed via PyPI, you can use t-linter from the command line:
+
+**Run the language server** (for editor integration):
+```bash
+t-linter lsp
+```
+
+**Check individual files**:
+```bash
+t-linter check file.py
+```
+
+**Get statistics** about template strings in a file:
+```bash
+t-linter stats file.py
+```
+
+## Quick Start Example
+
+Here's how to use template strings with automatic syntax highlighting:
+
+```python
+from typing import Annotated
+from string.templatelib import Template
+
+# HTML template with syntax highlighting
+page: Annotated[Template, "html"] = t"""
+<!DOCTYPE html>
+<html>
+    <head>
+        <title>{title}</title>
+        <style>
+            body { font-family: Arial, sans-serif; }
+            .highlight { color: #007acc; }
+        </style>
+    </head>
+    <body>
+        <h1 class="highlight">{heading}</h1>
+        <p>{content}</p>
+    </body>
+</html>
+"""
+
+# SQL query with syntax highlighting
+query: Annotated[Template, "sql"] = t"""
+SELECT u.name, u.email, p.title 
+FROM users u 
+JOIN posts p ON u.id = p.author_id 
+WHERE u.created_at > {start_date}
+ORDER BY u.name
+"""
+
+# Type aliases for reusable templates (Python 3.12+)
+type css = Annotated[Template, "css"]
+type js = Annotated[Template, "javascript"]
+
+styles: css = t"""
+.container {
+    max-width: 1200px;
+    margin: 0 auto;
+    padding: {padding}px;
+}
+"""
+```
+

editors/vscode/README.md

@@ -2,6 +2,8 @@
 
 Intelligent syntax highlighting and validation for Python template strings (PEP 750) with embedded language support.
 
+![T-Linter in action](images/img.png)
+
 ## Features
 
 - 🎨 **Smart Syntax Highlighting** - Automatic detection and highlighting of embedded languages
@@ -21,21 +23,57 @@ Intelligent syntax highlighting and validation for Python template strings (PEP
 
 - Visual Studio Code 1.74.0 or higher
 - Python 3.9+ (PEP 750 template strings require Python 3.14+)
-- `t-linter` language server (installed automatically or manually)
+- `t-linter` language server (must be installed via PyPI)
 
 ## Installation
 
-### Option 1: Install from VSCode Marketplace
-1. Open VSCode
-2. Go to Extensions (Ctrl+Shift+X)
-3. Search for "t-linter"
-4. Click Install
+**⚠️ Important**: This extension requires the t-linter language server to be installed separately.
 
-### Option 2: Install t-linter manually
+### Step 1: Install the t-linter language server
 ```bash
 pip install t-linter
 ```
 
+### Step 2: Install the VSCode extension
+1. Open VSCode
+2. Go to Extensions (Ctrl+Shift+X)
+3. Search for "t-linter"
+4. Click Install on "T-Linter - Python Template Strings Highlighter & Linter" by koxudaxi
+
+### Step 3: Configure server path (if needed)
+If the extension can't find the t-linter binary automatically:
+
+1. **Find your t-linter path**:
+   ```bash
+   which t-linter     # macOS/Linux
+   where t-linter     # Windows
+   ```
+
+2. **Set the path in VSCode settings**:
+   - Open Settings (Ctrl+, / Cmd+,)
+   - Search for `t-linter.serverPath`
+   - Enter the full path to your t-linter executable
+
+### Optional: PEP 750 Support with Patched Pyright
+
+Since PEP 750 template strings (`t"..."`) are not yet supported in the official Pyright extension, you can install a patched version that adds PEP 750 t-string support:
+
+1. **Download the patched Pyright extension**:
+   - Go to [Patched Pyright Releases](https://github.com/koxudaxi/pyright/releases/tag/untagged-7b5f847f7a434b72a328)
+   - Download the `.vsix` file
+
+2. **Install the patched extension**:
+   - Open VSCode
+   - Press `Ctrl+Shift+P` (Cmd+Shift+P on macOS)
+   - Type "Extensions: Install from VSIX..."
+   - Select the downloaded `.vsix` file
+
+3. **Disable the original Pyright extension** (if installed):
+   - Go to Extensions tab
+   - Find "Pyright" and click "Disable"
+
+This patched version enables Pyright to recognize and type-check PEP 750 template strings, providing better integration with t-linter for comprehensive template string analysis.
+
 ## Usage
 
 ### Basic Example
@@ -101,19 +139,34 @@ This extension contributes the following commands:
 ## Troubleshooting
 
 ### Language server not found
-If you see "t-linter binary not found", install it using:
-```bash
-pip install t-linter
-```
+If you see "t-linter binary not found":
+
+1. **Ensure t-linter is installed**:
+   ```bash
+   pip install t-linter
+   ```
+
+2. **Verify installation**:
+   ```bash
+   t-linter --version
+   ```
+
+3. **Configure server path manually**:
+   - Find the path: `which t-linter` (macOS/Linux) or `where t-linter` (Windows)
+   - Set `t-linter.serverPath` in VSCode settings
+   - Restart VSCode
 
 ### No syntax highlighting
-1. Ensure Python semantic highlighting is enabled
-2. Check that your template strings use the `t"..."` syntax
-3. Verify type annotations are correctly formatted
+1. Ensure both the PyPI package AND VSCode extension are installed
+2. Check that Python semantic highlighting is enabled in VSCode
+3. Verify your template strings use the `t"..."` syntax
+4. Ensure type annotations are correctly formatted
+5. Try restarting the language server: `Ctrl+Shift+P` → "T-Linter: Restart Server"
 
 ### Performance issues
 - Disable `t-linter.enableTypeChecking` if you don't need cross-module type resolution
 - Set `t-linter.trace.server` to "off" in production
+- Restart VSCode after changing settings
 
 ## Known Issues