Upload README.md with huggingface_hub

README.md

@@ -1,10 +1,115 @@
 ---
-title: Vnc Browser Agent
-emoji: 📚
+title: VNC Desktop + Browser Automation
+emoji: 🖥️
 colorFrom: blue
-colorTo: green
+colorTo: purple
 sdk: docker
-pinned: false
+app_port: 7860
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Linux Desktop with VNC + Browser Automation
+
+Full XFCE desktop with Playwright, Puppeteer, and CDP for AI agent control.
+
+## Features
+
+| Component | Description |
+|-----------|-------------|
+| **XFCE4 Desktop** | Full Linux desktop via noVNC |
+| **Chrome + CDP** | Chrome DevTools Protocol on port 9222 |
+| **Playwright** | Cross-browser automation (Chromium, Firefox, WebKit) |
+| **Puppeteer** | Chrome/Chromium automation |
+| **MCP Servers** | Model Context Protocol integration |
+| **CDP REST API** | HTTP endpoints for browser control |
+
+## Endpoints
+
+| Port | Service | Access |
+|------|---------|--------|
+| 7860 | noVNC Desktop | Browser (main UI) |
+| 8000 | CDP REST API | `https://SPACE.hf.space/api/` |
+| 9222 | Chrome CDP | WebSocket |
+
+## API Usage
+
+### Navigate
+```bash
+curl -X POST https://SPACE.hf.space:8000/navigate \
+  -H "Content-Type: application/json" \
+  -d '{"url": "https://example.com"}'
+```
+
+### Screenshot
+```bash
+curl -X POST https://SPACE.hf.space:8000/screenshot \
+  -H "Content-Type: application/json" \
+  -d '{"full_page": false}'
+```
+
+### Click Element
+```bash
+curl -X POST https://SPACE.hf.space:8000/click \
+  -H "Content-Type: application/json" \
+  -d '{"selector": "#button-id"}'
+```
+
+### Type Text
+```bash
+curl -X POST https://SPACE.hf.space:8000/type \
+  -H "Content-Type: application/json" \
+  -d '{"selector": "input[name=search]", "text": "hello world"}'
+```
+
+### Execute JavaScript
+```bash
+curl -X POST https://SPACE.hf.space:8000/evaluate \
+  -H "Content-Type: application/json" \
+  -d '{"expression": "document.title"}'
+```
+
+## MCP Integration
+
+Configure in Claude Desktop or other MCP clients:
+
+```json
+{
+  "mcpServers": {
+    "browser": {
+      "command": "npx",
+      "args": ["-y", "@anthropic/mcp-server-puppeteer"],
+      "env": {
+        "PUPPETEER_EXECUTABLE_PATH": "/usr/bin/google-chrome-stable"
+      }
+    }
+  }
+}
+```
+
+## Python Agent Example
+
+```python
+from browser_agent import BrowserAgent
+import asyncio
+
+async def main():
+    agent = BrowserAgent()
+    await agent.start()
+
+    await agent.goto("https://google.com")
+    await agent.type("textarea[name=q]", "AI automation")
+    await agent.press("Enter")
+
+    screenshot = await agent.screenshot()
+
+    await agent.stop()
+
+asyncio.run(main())
+```
+
+## Environment Variables
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| VNC_RESOLUTION | 1280x720 | Desktop resolution |
+| VNC_PASSWORD | vncpassword | VNC access password |
+| CHROME_CDP_PORT | 9222 | CDP WebSocket port |