Update README.md

README.md

@@ -10,3 +10,38 @@ pinned: false
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+# Web Scraper for n8n
+
+A lightweight web scraper API designed to work with n8n via HTTP Request nodes, deployed on Hugging Face Spaces.
+
+## Features
+- ✅ Direct HTML text extraction (fastest method)
+- ✅ BeautifulSoup parsing when available
+- ✅ Simple regex-based fallback parsing
+- ✅ FastAPI backend with CORS enabled
+- ✅ Gradio web interface for testing
+- ✅ Optimized for Hugging Face Spaces
+
+## Usage with n8n
+
+1. Deploy this space on Hugging Face
+2. In n8n, add an **HTTP Request** node
+3. Configure:
+   - **Method**: POST
+   - **URL**: `https://your-username-space-name.hf.space/scrape`
+   - **Headers**: `Content-Type: application/json`
+   - **Body**: 
+     ```json
+     {
+       "url": "{{ $json.url }}"
+     }
+     ```
+
+## API Endpoints
+
+- `GET /` - API documentation
+- `GET /health` - Health check
+- `POST /scrape` - Main scraping endpoint
+
+## Example n8n Workflow