From 0b68fd353f2faa4f00be9a2b90a549ad66d3f5ae Mon Sep 17 00:00:00 2001
From: diegosouzapw <8016841+diegosouzapw@users.noreply.github.com>
Date: Fri, 24 Jul 2026 09:24:30 -0300
Subject: [PATCH] Add comparison and zero-config installation diagrams in SVG
format
- Created a comparison table SVG illustrating the capabilities of OmniRoute versus competitors (9router, OpenRouter, CLIProxyAPI, LiteLLM) across 13 features.
- Added a zero-config installation SVG demonstrating the ease of setting up OmniRoute with three simple steps: installation, pointing to the tool, and receiving instant replies.
---
README.md | 200 ++++++++++++++--------------
docs/diagrams/comparison-table.svg | 138 +++++++++++++++++++
docs/diagrams/works-zero-config.svg | 117 ++++++++++++++++
3 files changed, 356 insertions(+), 99 deletions(-)
create mode 100644 docs/diagrams/comparison-table.svg
create mode 100644 docs/diagrams/works-zero-config.svg
diff --git a/README.md b/README.md
index 4fa585acca..23d4fe1753 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,7 @@
+
# 🚀 OmniRoute — The Free AI Gateway
@@ -16,13 +17,15 @@
-> Stacking free tiers by hand is painful — dozens of SDKs, dozens of rate limits, and no idea how much you actually have. OmniRoute aggregates the **documented** free tiers of **43 provider pools / 460+ models** into one honest number and shows it live on the dashboard (`/dashboard/free-tiers`).
+> Stacking free tiers by hand is painful — dozens of SDKs, dozens of rate limits, and no idea how much you actually have. OmniRoute aggregates the **documented** free tiers of **43 provider pools / 516 models** into one honest number and shows it live on the dashboard (`/dashboard/free-tiers`).
-
+
> Animated summary of the live `/dashboard/free-tiers` page. Full methodology (pool dedupe, credit tiers, provider terms): **[docs/reference/FREE_TIERS.md](docs/reference/FREE_TIERS.md)**.
>
-> These figures are re-audited every two weeks against the live catalog and **move both ways** — a provider ends a free tier and the number drops; a new one lands and it climbs. We publish what the catalog actually computes, never a rounded-up best case. A CI gate (`check:docs-counts`) fails the build if this headline drifts from the code.
+> These figures are re-audited every two weeks against the live catalog and **move both ways** — a provider ends a free tier and the number drops; a new one lands and it climbs. We publish what the catalog actually computes, never a rounded-up best case.
+
+
@@ -36,10 +39,13 @@
[](https://www.star-history.com/diegosouzapw/omniroute)
-
-
### 💬 Join the community
+**👋 Follow the maintainer — get new providers, releases & tips first:**
+
+[](https://www.linkedin.com/in/diegosouzapw/)
+[](https://github.com/diegosouzapw)
+
[](https://discord.gg/U47eFqAXCn)
[](https://t.me/omnirouteOficial)
[](https://chat.whatsapp.com/JI7cDQ1GyaiDHhVBpLxf8b?mode=gi_t)
@@ -59,74 +65,97 @@
-[**🚀 Quick Start**](#-quick-start) • [**🎯 Combos**](#-combos--the-flagship) • [**🌐 Providers**](#-290-ai-providers--90-free) • [**🔌 CLI & MCP**](#-full-cli--a2a--mcp) • [**🗜️ Compression**](#%EF%B8%8F-save-1595-tokens--automatically) • [**🌍 Website**](https://omniroute.online)
+
# 🆓 Works the second you install it — no keys, no config
-> **Install → point your tool at the endpoint → it already answers.** OmniRoute ships with keyless free providers (OpenCode Free, Felo) already wired into the `auto` combo, so a **fresh install responds out of the box** — no API key, no signup, no configuration.
+
```bash
# Fresh install, zero credentials — `auto` already works:
@@ -135,12 +164,10 @@ curl http://localhost:20128/v1/chat/completions \
-d '{"model":"auto","messages":[{"role":"user","content":"Hello!"}]}'
```
-- ✅ **`auto` responds immediately** — OmniRoute builds a virtual combo from the built-in keyless free providers and routes to a healthy one, with no setup.
-- ➕ **Add more providers anytime** — drop in a Claude / GPT / Gemini key (or any of the 290 providers) from the dashboard and they join the `auto` pool automatically.
-- 🎛️ **Build your own free combos** — chain your free tiers with any of the 19 routing strategies so you never run out of quota.
-
Prefer a specific free backend? Call it directly, e.g. `oc/…` (OpenCode Free) or `felo/…` (Felo). Then graduate to `auto` and let OmniRoute pick.
+
+
# 💥 The Promise
@@ -168,7 +195,11 @@ curl http://localhost:20128/v1/chat/completions \
-## 🤝 Supported by our Open Source Friends
+
+
+
```bash
# Fresh install, zero credentials — `auto` already works:
@@ -135,12 +164,10 @@ curl http://localhost:20128/v1/chat/completions \
-d '{"model":"auto","messages":[{"role":"user","content":"Hello!"}]}'
```
-- ✅ **`auto` responds immediately** — OmniRoute builds a virtual combo from the built-in keyless free providers and routes to a healthy one, with no setup.
-- ➕ **Add more providers anytime** — drop in a Claude / GPT / Gemini key (or any of the 290 providers) from the dashboard and they join the `auto` pool automatically.
-- 🎛️ **Build your own free combos** — chain your free tiers with any of the 19 routing strategies so you never run out of quota.
-
Prefer a specific free backend? Call it directly, e.g. `oc/…` (OpenCode Free) or `felo/…` (Felo). Then graduate to `auto` and let OmniRoute pick.
+
+
> A **combo** is a chain of models OmniRoute routes across **automatically**. Quota runs out, a provider fails, or costs spike — the combo silently slides to the next model. **This is what makes OmniRoute unbreakable.** 🛡️
### ⚡ Zero-config — just use `auto`
@@ -251,29 +284,10 @@ All **19** strategies — mix & match per combo step:
| 18 | `fusion` | Fan out to a panel of models + a judge synthesizes one answer 🧬 |
| 19 | `pipeline` | Chain steps — each target's output feeds the next one 🔗 |
-
-
-Enforced in the hot path **before** the request leaves OmniRoute, with per-(key, model) caps + session stickiness for prompt-cache integrity (now with a per-combo / global disable toggle). 📖 [Quota Sharing Engine](docs/routing/QUOTA_SHARE.md)
-
-##
-
### 🧱 Resilience is built in (3 independent layers)
@@ -288,22 +302,9 @@ All **19** strategies — mix & match per combo step:
-| Feature | OmniRoute | Other routers |
-| -------------------------------------- | -------------------------------------- | ------------- |
-| 🌐 Providers | **290** | 20–100 |
-| 🆓 Free providers | **90+ (40+ free forever)** | 1–5 |
-| 🔀 Routing strategies | **19** strategies | 1–3 |
-| 🗜️ Token compression | **RTK + Caveman stacked (15–95%)** | None / 20–40% |
-| 🧰 Built-in MCP server | **104 tools, 3 transports, 31 scopes** | Rare |
-| 🤝 A2A agent protocol | **6 skills, JSON-RPC 2.0** | None |
-| 🧠 Memory (FTS5 + vector) | **Yes** | Rare |
-| 🛡️ Guardrails (PII, injection, vision) | **Yes** | Rare |
-| ☁️ Cloud agents | **Codex, Cursor, Devin, Jules** | None |
-| 🥷 TLS fingerprint stealth | **JA3/JA4 via wreq-js** | None |
-| 🖥️ Multi-platform | **Web · Desktop · Termux · PWA** | Web only |
-| 🌍 i18n | **43 locales** | 0–4 |
+
-📊 Detailed comparison vs LiteLLM, OpenRouter & Portkey → [`docs/comparison/OMNIROUTE_VS_ALTERNATIVES.md`](docs/comparison/OMNIROUTE_VS_ALTERNATIVES.md)
+📊 Full methodology & per-feature detail vs 9router, OpenRouter, CLIProxyAPI & LiteLLM → [`docs/comparison/OMNIROUTE_VS_ALTERNATIVES.md`](docs/comparison/OMNIROUTE_VS_ALTERNATIVES.md)