From c300dfe93b63c472bb23b8f77b4152b28e1cfaf6 Mon Sep 17 00:00:00 2001 From: Diego Rodrigues de Sa e Souza Date: Sun, 19 Jul 2026 04:17:33 -0300 Subject: [PATCH] =?UTF-8?q?docs(readme):=20animated=20hero=20card=20+=20Th?= =?UTF-8?q?e=20Promise=20six-pillar=20card=20=E2=80=94=20embed=20replaces?= =?UTF-8?q?=20hero=20text=20block,=20six=20static=20badges=20and=20the=20p?= =?UTF-8?q?romise=20HTML=20table;=20all=20numbers=20from=20the=20v3.8.49?= =?UTF-8?q?=20audit?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 59 ++--------- docs/diagrams/README.md | 18 ++-- docs/diagrams/promise-pillars.svg | 161 ++++++++++++++++++++++++++++++ docs/diagrams/readme-hero.svg | 154 ++++++++++++++++++++++++++++ 4 files changed, 336 insertions(+), 56 deletions(-) create mode 100644 docs/diagrams/promise-pillars.svg create mode 100644 docs/diagrams/readme-hero.svg diff --git a/README.md b/README.md index e2d552843d..3fd2f9867a 100644 --- a/README.md +++ b/README.md @@ -6,38 +6,14 @@ # πŸš€ OmniRoute β€” The Free AI Gateway -### Never stop coding. Connect every AI tool to **268 providers** β€” **90+ free** β€” through one endpoint. +OmniRoute β€” Never stop coding. Every AI tool β†’ 268 providers β€” 90+ free β€” through one endpoint. Claude Code, Codex, Cursor, Cline, Copilot & Antigravity into FREE Claude / GPT / Gemini with auto-fallback. ~1.6B documented free tokens/month β€” up to ~2.1B in your first month with signup credits. RTK + Caveman compression saves 15–95% tokens. 18 routing strategies. $0 to start. -**Plug Claude Code, Codex, Cursor, Cline, Copilot & Antigravity into FREE Claude / GPT / Gemini. Auto-fallback.** -
- -**RTK + Caveman compression saves 15–95% tokens. Never hit limits.** - -
- -**~1.6B documented free tokens/month** β€” up to **~2.1B in your first month** with signup credits β€” aggregated across the free tiers, plus a long tail of permanently-free, no-cap providers, and the compression above stretches every one further. ([how we count β†’](docs/reference/FREE_TIERS.md#tldr--how-much-free-inference-does-omniroute-actually-aggregate)) - -
- -

- -⭐ Star the repo if OMNIROUTE helped you save money and make your work easier. - -

+([how we count β†’](docs/reference/FREE_TIERS.md#tldr--how-much-free-inference-does-omniroute-actually-aggregate)) [![Stars](https://img.shields.io/github/stars/diegosouzapw/OmniRoute?style=social)](https://github.com/diegosouzapw/OmniRoute) diegosouzapw%2FOmniRoute | Trendshift [![Star History Rank](https://api.star-history.com/badge?repo=diegosouzapw/OmniRoute&theme=dark)](https://www.star-history.com/diegosouzapw/omniroute) -
- -[![268 AI Providers](https://img.shields.io/badge/268-AI_Providers-6C5CE7?style=for-the-badge)](#-268-ai-providers--90-free) -[![90+ Free](https://img.shields.io/badge/90%2B-Free_Tiers-00B894?style=for-the-badge)](#-268-ai-providers--90-free) -[![1.6B Free Tokens/mo](https://img.shields.io/badge/1.6B-Free_Tokens%2Fmo-00B894?style=for-the-badge)](docs/reference/FREE_TIERS.md) -[![Token Savings](https://img.shields.io/badge/up_to_95%25-Token_Savings-E17055?style=for-the-badge)](#%EF%B8%8F-save-1595-tokens--automatically) -[![18 Strategies](https://img.shields.io/badge/18-Routing_Strategies-0984E3?style=for-the-badge)](#-combos--the-flagship) -[![$0 to start](https://img.shields.io/badge/%240-To_Start-FDCB6E?style=for-the-badge&logoColor=black)](#-quick-start) -
### πŸ’¬ Join the community @@ -144,20 +120,7 @@ -> One endpoint. **268 providers.** Never stop building β€” and let OmniRoute pick the cheapest one that works. - - - - - - - - - - - - -
🚫 Never hit limits
Auto-fallback across 268 providers in milliseconds. Quota out? Next provider takes over β€” zero downtime.		πŸ’Έ Save up to 95% tokens
RTK + Caveman stacked compression cuts 15–95% of eligible tokens (~89% avg on tool-heavy sessions).		πŸ†“ $0 to start
90+ providers with a free tier, 40+ free forever (Qoder, Pollinations, Cloudflare, SiliconFlow…). No card needed.
πŸ”Œ Every tool works
26 coding agents β€” Claude Code, Codex, Cursor, Cline, Copilot, Antigravity β€” through one config.		🧩 One endpoint
OpenAI ↔ Claude ↔ Gemini ↔ Responses API translation. Point any tool at /v1 and it just works.		πŸ›‘οΈ Production-grade
Circuit breakers, TLS stealth, MCP (104 tools), A2A, memory, guardrails, evals. 25,000+ tests.
+The Promise β€” One endpoint. 268 providers. Never stop building β€” OmniRoute picks the cheapest one that works. Six pillars: Never hit limits (auto-fallback across 268 providers in milliseconds, zero downtime) Β· Save up to 95% tokens (RTK + Caveman stacked compression cuts 15–95%, ~89% avg on tool-heavy sessions) Β· $0 to start (90+ free tiers, 40+ free forever β€” no card needed) Β· Every tool works (26 coding agents through one config) Β· One endpoint (OpenAI ↔ Claude ↔ Gemini ↔ Responses API at /v1) Β· Production-grade (circuit breakers, TLS stealth, MCP 104 tools, A2A, memory, guardrails, evals β€” 25,000+ tests).

@@ -279,10 +242,10 @@ All **18** strategies β€” mix & match per combo step: | Feature | OmniRoute | Other routers | | -------------------------------------- | ------------------------------------------------------------------- | ------------- | | 🌐 Providers | **268** | 20–100 | -| πŸ†“ Free providers | **90+ (40+ free forever)** | 1–5 | +| πŸ†“ Free providers | **90+ (40+ free forever)** | 1–5 | | πŸ”€ Routing strategies | **18** (priority, weighted, cost-optimized, context-relay, fusion…) | 1–3 | | πŸ—œοΈ Token compression | **RTK + Caveman stacked (15–95%)** | None / 20–40% | -| 🧰 Built-in MCP server | **104 tools, 3 transports, 30 scopes** | Rare | +| 🧰 Built-in MCP server | **104 tools, 3 transports, 30 scopes** | Rare | | 🀝 A2A agent protocol | **6 skills, JSON-RPC 2.0** | None | | 🧠 Memory (FTS5 + vector) | **Yes** | Rare | | πŸ›‘οΈ Guardrails (PII, injection, vision) | **Yes** | Rare | @@ -517,12 +480,12 @@ Tokens are scoped `read` / `write` / `admin`; process-spawning routes stay loopb Expose OmniRoute over **MCP** or **A2A** and any capable agent gets the keys to the whole gateway β€” routing, providers, combos, cache, compression, memory β€” autonomously. -| Protocol | Endpoint | Use it for | -| ------------------ | ----------------------------------------------- | ------------------------------------------------------ | -| 🧰 **MCP (stdio)** | `omniroute --mcp` | Plug into Claude Desktop, Cursor, any MCP client | +| Protocol | Endpoint | Use it for | +| ------------------ | ----------------------------------------------- | ------------------------------------------------------- | +| 🧰 **MCP (stdio)** | `omniroute --mcp` | Plug into Claude Desktop, Cursor, any MCP client | | 🌊 **MCP (HTTP)** | `http://localhost:20128/api/mcp/stream` | Remote MCP β€” **104 tools**, 30 scopes, full audit trail | -| πŸ“‘ **MCP (SSE)** | `http://localhost:20128/api/mcp/sse` | Streaming MCP transport | -| 🀝 **A2A** | `http://localhost:20128/.well-known/agent.json` | Agent-to-agent, **JSON-RPC 2.0** + SSE, 6 skills | +| πŸ“‘ **MCP (SSE)** | `http://localhost:20128/api/mcp/sse` | Streaming MCP transport | +| 🀝 **A2A** | `http://localhost:20128/.well-known/agent.json` | Agent-to-agent, **JSON-RPC 2.0** + SSE, 6 skills | ```bash # Give Claude Code the full OmniRoute toolset over MCP: @@ -885,7 +848,7 @@ same process on one port, so there is no separate CLI-only package today. | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | | [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [MCP Server](open-sse/mcp-server/README.md) | 104 MCP tools, IDE configs, Python/TS/Go clients | +| [MCP Server](open-sse/mcp-server/README.md) | 104 MCP tools, IDE configs, Python/TS/Go clients | | [MCP Server Guide](docs/frameworks/MCP-SERVER.md) | MCP installation, transports, and tool reference | | [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | | [A2A Server Guide](docs/frameworks/A2A-SERVER.md) | A2A agent card, tasks, skills, and streaming | diff --git a/docs/diagrams/README.md b/docs/diagrams/README.md index 8f318a5e32..27a6679abc 100644 --- a/docs/diagrams/README.md +++ b/docs/diagrams/README.md @@ -27,14 +27,16 @@ Not every diagram comes from a `.mmd` source. Hand-authored SVGs live at this directory's root and animate with SMIL only (no JS, no external fonts), so they play inside GitHub's `` sandbox: -| File | Used in | Notes | -| ---------------------------------------- | ---------------- | ---------------------------------------------------------------------------- | -| [tier-cascade.svg](./tier-cascade.svg) | README.md (root) | Animated 4-tier auto-fallback cascade (16s loop, 4 acts). Edit the SVG directly β€” there is no `.mmd` source. | -| [pool-fair-share.svg](./pool-fair-share.svg) | README.md (root) | Animated key-pool fair-share quota (generous β†’ strict, 16s loop). Edit the SVG directly β€” there is no `.mmd` source. | -| [combo-always-on.svg](./combo-always-on.svg) | README.md (root) | Animated priority-combo fallback (4 layers, 16s loop). Edit the SVG directly β€” there is no `.mmd` source. | -| [cli-terminal.svg](./cli-terminal.svg) | README.md (root) | Animated terminal cycling 3 CLI commands (providers/combo/health) + subcommand ticker (18s loop). Edit the SVG directly β€” there is no `.mmd` source. | -| [compression-pipeline.svg](./compression-pipeline.svg) | README.md (root) | Animated 10-engine compression funnel (8s loop). Edit the SVG directly β€” there is no `.mmd` source. | -| [free-tier-budget.svg](./free-tier-budget.svg) | README.md (root) | Animated free-tier budget card (~1.6B/mo headline, 21-pool budget bar, per-model grid, signup credits, 10s loop). Edit the SVG directly β€” there is no `.mmd` source. | +| File | Used in | Notes | +| ------------------------------------------------------ | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [tier-cascade.svg](./tier-cascade.svg) | README.md (root) | Animated 4-tier auto-fallback cascade (16s loop, 4 acts). Edit the SVG directly β€” there is no `.mmd` source. | +| [pool-fair-share.svg](./pool-fair-share.svg) | README.md (root) | Animated key-pool fair-share quota (generous β†’ strict, 16s loop). Edit the SVG directly β€” there is no `.mmd` source. | +| [combo-always-on.svg](./combo-always-on.svg) | README.md (root) | Animated priority-combo fallback (4 layers, 16s loop). Edit the SVG directly β€” there is no `.mmd` source. | +| [cli-terminal.svg](./cli-terminal.svg) | README.md (root) | Animated terminal cycling 3 CLI commands (providers/combo/health) + subcommand ticker (18s loop). Edit the SVG directly β€” there is no `.mmd` source. | +| [compression-pipeline.svg](./compression-pipeline.svg) | README.md (root) | Animated 10-engine compression funnel (8s loop). Edit the SVG directly β€” there is no `.mmd` source. | +| [free-tier-budget.svg](./free-tier-budget.svg) | README.md (root) | Animated free-tier budget card (~1.6B/mo headline, 21-pool budget bar, per-model grid, signup credits, 10s loop). Edit the SVG directly β€” there is no `.mmd` source. | +| [readme-hero.svg](./readme-hero.svg) | README.md (root) | Animated hero card (tagline, 268-provider/90+ free headline, ~1.6B stat, compression bar demo, 6 stat chips, star CTA). Edit the SVG directly β€” there is no `.mmd` source. | +| [promise-pillars.svg](./promise-pillars.svg) | README.md (root) | Animated "The Promise" 6-pillar card (fade-in + 12s border-highlight sweep). Edit the SVG directly β€” there is no `.mmd` source. | ## How to update diff --git a/docs/diagrams/promise-pillars.svg b/docs/diagrams/promise-pillars.svg new file mode 100644 index 0000000000..f883f541fb --- /dev/null +++ b/docs/diagrams/promise-pillars.svg @@ -0,0 +1,161 @@ + + Animated promise card: six pillar tiles fade in in reading order, then a soft colored border highlight sweeps from tile to tile in a continuous cycle. + + + + + + + + + + + + + + + + + + + + + + + + + THE PROMISE + + + + + + One endpoint. 268 providers. Never stop building β€” OmniRoute picks the cheapest one that works. + + + + + + + + + + + + + + + + + + Never hit limits + Auto-fallback across 268 providers in + milliseconds. Quota out? The next provider + takes over β€” zero downtime. + + + + + + + + + + + + + + + + + Save up to 95% tokens + RTK + Caveman stacked compression cuts + 15–95% of eligible tokens β€” ~89% average + on tool-heavy sessions. + + + + + + + + + + + + + + + + $0 to start + 90+ providers with a free tier, 40+ free + forever β€” Qoder, Pollinations, Cloudflare, + SiliconFlow… No card needed. + + + + + + + + + + + + + + + + + Every tool works + 26 coding agents β€” Claude Code, Codex, + Cursor, Cline, Copilot, Antigravity β€” + through one config. + + + + + + + + + + + + + + + + One endpoint + OpenAI ↔ Claude ↔ Gemini ↔ Responses API + translation. Point any tool at /v1 β€” + it just works. + + + + + + + + + + + + + + + + Production-grade + Circuit breakers, TLS stealth, MCP (104 + tools), A2A, memory, guardrails, evals β€” + 25,000+ tests. + + + + + + + $ npm i -g omniroute  Β·  point your tool at http://localhost:20128/v1  Β·  $0 + MIT Β· OPEN SOURCE + + diff --git a/docs/diagrams/readme-hero.svg b/docs/diagrams/readme-hero.svg new file mode 100644 index 0000000000..8f040fe86e --- /dev/null +++ b/docs/diagrams/readme-hero.svg @@ -0,0 +1,154 @@ + + Animated hero card: the tagline, provider stats, free-token headline and stat chips fade in in sequence; a compression bar repeatedly shrinks a prompt by up to 95 percent, a pulse travels the divider and the star gently twinkles. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + OMNIROUTE β€” THE FREE AI GATEWAY + ONE ENDPOINT Β· /v1 + + + + + + + Never stop coding. + + + + + + + Every AI tool β†’ 268 providers β€” 90+ free β€” through one endpoint. + + + + + + + Claude Code Β· Codex Β· Cursor Β· Cline Β· Copilot Β· Antigravity  β†’  FREE Claude / GPT / Gemini Β· auto-fallback + + + + + + + + + + + + + + + + ~1.6B + documented free tokens / month + up to ~2.1B in your first month with signup credits + + a long tail of permanently-free, no-cap providers + honest, pool-deduped math β€” each shared pool counted once + + + + + + + + RTK + CAVEMAN Β· STACKED COMPRESSION + Save 15–95% tokens + + + + + + your prompt + + + βˆ’89% avg on tool-heavy sessions + + + never hit limits + + + + + + + + 268 + AI PROVIDERS + + + + + 90+ + FREE TIERS + + + + + ~1.6B + FREE TOKENS / MO + + + + + 15–95% + TOKEN SAVINGS + + + + + 18 + ROUTING STRATEGIES + + + + + $0 + TO START + + + + + + + + + + + + + Star the repo if OmniRoute helped you save money and make your work easier. + $ npm i -g omniroute + +