@thomas-huang/caosi 0.2.0 → 0.3.0

package/README.md

@@ -1,12 +1,16 @@
+<p align="center">
+  <img src="assets/logo/caosi-icon.svg" width="88" height="88" alt="caosi">
+</p>
+
 # caosi
 
 [中文](README.zh-CN.md)
 
 Keep using Claude Code, Codex, or Gemini CLI. Point them at your own upstream — no client switch.
 
-Set the Base URL to `http://127.0.0.1:9999/{provider_name}`. Same protocol is passed through; caosi converts when they differ.
+Set the Base URL to `http://127.0.0.1:9999/{provider_name}`. OpenAI Chat, OpenAI Responses, Claude Messages, and Gemini convert in every direction; same protocol is passed through.
 
-- A single static binary
+- A single static binary. No Docker.
 - npm ships the binaries: no install script, nothing fetched from GitHub
 - macOS, Linux, and Windows
 
@@ -23,7 +27,7 @@ npm install -g @thomas-huang/caosi
 caosi --version
 ```
 
-Needs Node.js 18+ on macOS, Linux, or Windows (amd64). The npm package includes native binaries; there is no install script and nothing is fetched from GitHub at install time.
+Needs Node.js 18+ on macOS or Linux (amd64 and arm64), or Windows (amd64). The npm package includes native binaries; there is no install script and nothing is fetched from GitHub at install time.
 
 ## Run
 
@@ -89,15 +93,18 @@ export GEMINI_API_BASE=http://127.0.0.1:9999/openrouter
 | `claude_messages` | Claude Messages |
 | `gemini` | Gemini generateContent |
 
-- `model` is optional: when set, it replaces the client's model name on the upstream request.
+- `model` is optional: when set, it replaces the client's model name on the upstream request, including when the protocols already match.
 - `headers` is optional extra request headers (for example OpenRouter).
 - `base_url` is a prefix. caosi does not strip `/v1`. Use the root the upstream actually expects (`https://openrouter.ai/api`, not `https://openrouter.ai/api/v1`).
 
+Same protocol is copied through. Different protocols remap the body: text, system instruction, tools, thinking, Thinking Signature, in-message images, documents, audio, and video, and Usage Details (reasoning / cache-read / cache-create token counts) are kept when the other protocol can express them; otherwise that part is dropped and the rest is sent. caosi does not fetch URLs or Files API objects (`file_id`, `fileUri`). Dedicated image, files, audio, video, and embeddings paths stay 404.
+
 ## Listen, health, reload
 
 - Loopback only: `127.0.0.1` (or `::1` via `--listen`). Default port `9999` (`--port`).
-- `GET /health`
+- `GET /health` returns JSON with the current Provider Names.
 - Saving `providers.jsonc` hot-reloads; a bad file keeps the last good config.
+- Request and JSON-response bodies over 32MiB are rejected (413).
 - Flags: `--config-dir`, `--port`, `--listen`, `--log-level`, `--version`.
 
 ## What it does not do

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thomas-huang/caosi",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Local converter between LLM client protocols and named upstream providers",
   "license": "MIT",
   "homepage": "https://github.com/thomas-huang/caosi",