diff --git a/README.md b/README.md index f72a5b2b5e..35f4e9eea2 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

-# ๐Ÿš€ OmniRoute โ€” The Free AI Gateway +## ๐Ÿš€ OmniRoute โ€” The Free AI Gateway OmniRoute โ€” Never stop coding. Every AI tool โ†’ 290 providers โ€” 90+ free โ€” through one endpoint. Claude Code, Codex, Cursor, Cline, Copilot & Antigravity into FREE Claude / GPT / Gemini with auto-fallback. RTK + Caveman stacked compression saves 15โ€“95% tokens (~89% avg) โ€” never hit limits. 290 AI providers ยท 90+ free tiers ยท ~1.53B free tokens/mo ยท 19 routing strategies ยท $0 to start. @@ -13,7 +13,7 @@
-# ๐Ÿ’ฐ ~1.53B Free Tokens / Month +## ๐Ÿ’ฐ ~1.53B Free Tokens / Month
@@ -56,7 +56,7 @@
-### ๐Ÿงฉ Available +## ๐Ÿงฉ Available [![npm version](https://img.shields.io/npm/v/omniroute?color=cb3837&logo=npm)](https://www.npmjs.com/package/omniroute) ![NPM Monthly](https://img.shields.io/npm/dm/omniroute?label=npm/month&color=cb3837&logo=npm) @@ -151,7 +151,7 @@
-# ๐Ÿ†“ Works the second you install it โ€” no keys, no config +## ๐Ÿ†“ Works the second you install it โ€” no keys, no config
@@ -170,7 +170,7 @@ curl http://localhost:20128/v1/chat/completions \
-# ๐Ÿ’ฅ The Promise +## ๐Ÿ’ฅ The Promise
@@ -181,7 +181,7 @@ curl http://localhost:20128/v1/chat/completions \
-# ๐Ÿค” Why OmniRoute? +## ๐Ÿค” Why OmniRoute?
@@ -197,7 +197,7 @@ curl http://localhost:20128/v1/chat/completions \
-# ๐Ÿค Supported by our Open Source Friends +## ๐Ÿค Supported by our Open Source Friends
@@ -235,7 +235,7 @@ curl http://localhost:20128/v1/chat/completions \
-# ๐ŸŽฏ Combos โ€” The Flagship +## ๐ŸŽฏ Combos โ€” The Flagship
@@ -298,7 +298,7 @@ All **19** strategies โ€” mix & match per combo step:
-# ๐Ÿ† What Sets OmniRoute Apart +## ๐Ÿ† What Sets OmniRoute Apart
@@ -320,7 +320,7 @@ OmniRoute is free and open source, built and maintained in the open. If it saves
-# โœจ What's New +## โœจ What's New
@@ -347,7 +347,7 @@ OmniRoute is free and open source, built and maintained in the open. If it saves
-# ๐Ÿค– Compatible CLIs & Coding Agents +## ๐Ÿค– Compatible CLIs & Coding Agents > One config โ€” `http://localhost:20128/v1` โ€” and **every** AI IDE or CLI runs on free & low-cost models. @@ -400,7 +400,7 @@ OmniRoute is free and open source, built and maintained in the open. If it saves
-# ๐ŸŒ 290 AI Providers โ€” 90+ Free +## ๐ŸŒ 290 AI Providers โ€” 90+ Free
@@ -469,7 +469,7 @@ OmniRoute is free and open source, built and maintained in the open. If it saves
-# ๐Ÿ–ฅ๏ธ Where OmniRoute Runs โ€” Anywhere +## ๐Ÿ–ฅ๏ธ Where OmniRoute Runs โ€” Anywhere
@@ -492,7 +492,7 @@ OmniRoute is free and open source, built and maintained in the open. If it saves
-# ๐Ÿ”’ Private & Local-First +## ๐Ÿ”’ Private & Local-First
@@ -504,7 +504,7 @@ OmniRoute is free and open source, built and maintained in the open. If it saves
-# ๐Ÿ”Œ Full CLI + A2A & MCP +## ๐Ÿ”Œ Full CLI + A2A & MCP
@@ -566,10 +566,24 @@ claude mcp add-server omniroute --type http --url http://localhost:20128/api/mcp
-# ๐Ÿ—œ๏ธ Save 15โ€“95% Tokens โ€” Automatically +## ๐Ÿ—œ๏ธ Save 15โ€“95% Tokens โ€” Automatically
+### ๐Ÿ“– How it works โ€” pipeline, architecture & savings math + +OmniRoute compression pipeline: a client request of 10,000 tokens passes through 12 stacked engines โ€” Session-Dedup, CCR, Lite, RTK, Responses Tool Output, Headroom, Relevance, Caveman, Aggressive, LLMLingua-2, Ultra, OmniGlyph โ€” and reaches the provider at about 1,080 tokens, up to 95% saved. Code, URLs and JSON are always preserved byte-perfect. + +Default stacked combo runs `RTK โ†’ Caveman`. When both act on the same tool/context payload, savings compound: + +```txt +combined = 1 โˆ’ (1 โˆ’ RTK) ร— (1 โˆ’ Caveman_input) +average = 1 โˆ’ (1 โˆ’ 0.80) ร— (1 โˆ’ 0.46) = 89.2% +range = 78.4 โ€“ 94.6% +``` + +Code blocks, URLs, JSON and structured data are **always protected** by the preservation engine. + > **Why use many tokens when few tokens do the trick?** Every request passes through OmniRoute's compression pipeline **transparently** โ€” no client changes. It's now a **stack of 12 composable engines** that run in order and mix & match per routing combo โ€” building on ideas from [RTK](https://github.com/rtk-ai/rtk), [Caveman](https://github.com/JuliusBrussee/caveman) (โญ 90K+), [LLMLingua-2](https://github.com/microsoft/LLMLingua), and [Troglodita](https://github.com/leninejunior/troglodita) (PT-BR). ### ๐Ÿงฑ The 12-engine stack @@ -620,20 +634,6 @@ Code blocks, URLs and structured data are **always preserved** byte-perfect. **O
-### ๐Ÿ“– How it works โ€” pipeline, architecture & savings math - -OmniRoute compression pipeline: a client request of 10,000 tokens passes through 12 stacked engines โ€” Session-Dedup, CCR, Lite, RTK, Responses Tool Output, Headroom, Relevance, Caveman, Aggressive, LLMLingua-2, Ultra, OmniGlyph โ€” and reaches the provider at about 1,080 tokens, up to 95% saved. Code, URLs and JSON are always preserved byte-perfect. - -Default stacked combo runs `RTK โ†’ Caveman`. When both act on the same tool/context payload, savings compound: - -```txt -combined = 1 โˆ’ (1 โˆ’ RTK) ร— (1 โˆ’ Caveman_input) -average = 1 โˆ’ (1 โˆ’ 0.80) ร— (1 โˆ’ 0.46) = 89.2% -range = 78.4 โ€“ 94.6% -``` - -Code blocks, URLs, JSON and structured data are **always protected** by the preservation engine. - ### ๐ŸŽš๏ธ Beyond the engines โ€” output styles, the adaptive dial & per-request control The 12 engines above shrink what goes **in**. Three more layers shape **how**, **when**, and what comes **out**: