📝 Update README with detailed documentation for LLM Proxy

2026-04-19 09:28:02 +08:00
parent 017377a6e5
commit c3dae19a03
6 changed files with 317 additions and 1 deletions
@@ -1,2 +1,36 @@
-# llm-proxy-go
+# LLM Proxy

+HTTP proxy for LLM APIs with streaming support and chunk processing.
+
+## Usage
+
+```bash
+./llm-proxy
+```
+
+## Configuration
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `UPSTREAM_URL` | Upstream LLM API URL | `https://api.openai.com/v1/chat/completions` |
+| `LISTEN_ADDR` | Listen address | `:8080` |
+| `API_KEY` | Upstream API key | - |
+| `INSECURE` | Skip TLS verification | `false` |
+
+## Example
+
+```bash
+UPSTREAM_URL=https://api.openai.com/v1/chat/completions \
+API_KEY=sk-... \
+LISTEN_ADDR=:8080 \
+./llm-proxy
+```
+
+## Endpoints
+
+- `GET /health` - Health check
+- `/*` - Proxies all requests to upstream
+
+## Streaming
+
+Supports SSE (`text/event-stream`) and NDJSON (`application/x-ndjson`) streaming. Each chunk is processed via `processChunk()` before forwarding.