From 44eb05469a62fa9b22d7e2b873527f19902a1207 Mon Sep 17 00:00:00 2001 From: diegosouzapw <8016841+diegosouzapw@users.noreply.github.com> Date: Fri, 24 Jul 2026 11:29:18 -0300 Subject: [PATCH] docs: improve formatting and structure in README for better readability --- README.md | 181 ++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 121 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index 35f4e9eea2..5a87123308 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. @@ -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?
@@ -262,27 +262,108 @@ No combo to create. Set your model to `auto` (or a variant) and OmniRoute builds All **19** strategies — mix & match per combo step: -| # | Strategy | What it does                                                                                                                                                             | -| --- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| 1 | `priority` | First-target ordered list — drain each before the next 🥇 | -| 2 | `fill-first` | Fill each target's quota fully before moving on | -| 3 | `weighted` | Weighted random by per-target weight | -| 4 | `round-robin` | Cycle through targets in order | -| 5 | `p2c` | Power-of-two-choices random load balancing | -| 6 | `least-used` | Pick the target with the lowest current load | -| 7 | `random` | Uniform random pick (deduplicated) | -| 8 | `strict-random` | Random without de-duplicating repeats 🎲 | -| 9 | `cost-optimized` | Minimize $ per request from live catalog pricing 💸 | -| 10 | `headroom` | Pick the target with the most remaining quota | -| 11 | `reset-window` | Prefer the target whose quota window resets soonest | -| 12 | `reset-aware` | Rank by quota reset time — short windows first 📊 | -| 13 | `context-relay` | Hand off context across targets for long conversations 🧠 | -| 14 | `context-optimized` | Pick the best fit for the current context size | -| 15 | `cache-optimized` | Pin each reusable prompt prefix to the same account — maximize prompt-cache hits 🎯 | -| 16 | `lkgp` | Last-Known-Good Path — sticky to the last successful target | -| 17 | `auto` | 12-factor live scoring across every connection 🤖 | -| 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 🔗 | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#StrategyWhat it does
1priorityFirst-target ordered list — drain each before the next 🥇
2fill-firstFill each target's quota fully before moving on
3weightedWeighted random by per-target weight
4round-robinCycle through targets in order
5p2cPower-of-two-choices random load balancing
6least-usedPick the target with the lowest current load
7randomUniform random pick (deduplicated)
8strict-randomRandom without de-duplicating repeats 🎲
9cost-optimizedMinimize $ per request from live catalog pricing 💸
10headroomPick the target with the most remaining quota
11reset-windowPrefer the target whose quota window resets soonest
12reset-awareRank by quota reset time — short windows first 📊
13context-relayHand off context across targets for long conversations 🧠
14context-optimizedPick the best fit for the current context size
15cache-optimizedPin each reusable prompt prefix to the same account — maximize prompt-cache hits 🎯
16lkgpLast-Known-Good Path — sticky to the last successful target
17auto12-factor live scoring across every connection 🤖
18fusionFan out to a panel of models + a judge synthesizes one answer 🧬
19pipelineChain steps — each target's output feeds the next one 🔗
The Auto-Combo engine scores every candidate on **12 factors** (health, quota, cost, latency, success rate, freshness…) — see [`docs/routing/AUTO-COMBO.md`](docs/routing/AUTO-COMBO.md). @@ -535,9 +616,9 @@ omniroute contexts use default # ← switch back to the local server Tokens are scoped `read` / `write` / `admin`; process-spawning routes stay loopback-only. 📖 [Remote Mode](docs/guides/REMOTE-MODE.md) -
+
-Animated terminal demoing the OmniRoute CLI — omniroute providers list, omniroute combo list, omniroute health — cycling over the 80+ command surface: providers · oauth · keys · combo · nodes · models · cache · compression · cost · usage · quota · health · resilience · telemetry · logs · audit · mcp · a2a · cloud · memory · skills · eval · tunnel · backup · sync · webhooks · policy · pricing · translator · simulate … +Animated terminal demoing the OmniRoute CLI — omniroute providers list, omniroute combo list, omniroute health — cycling over the 80+ command surface: providers · oauth · keys · combo · nodes · models · cache · compression · cost · usage · quota · health · resilience · telemetry · logs · audit · mcp · a2a · cloud · memory · skills · eval · tunnel · backup · sync · webhooks · policy · pricing · translator · simulate …
@@ -814,43 +895,23 @@ same process on one port, so there is no separate CLI-only package today.
-# 📸 Dashboard Screenshots - -
- -
- - - - - - - - - - - - - - - - - -
Providers
Providers		Combos
Combos
Analytics
Analytics		Health
Health
Translator
Translator		Settings
Settings
CLI Tools
CLI Tools		Usage Logs
Usage Logs
-
- -
- -
- # 📧 Support & Community -> 💬 **Chat with the community** — Discord, Telegram & WhatsApp (🌍 / 🇧🇷) links are at the [top of this README](#-join-the-community). +> Everything in one place — follow the maintainer, chat with the community, or open an issue. -- 🌍 **Website**: [omniroute.online](https://omniroute.online) -- 🐙 **GitHub**: [github.com/diegosouzapw/OmniRoute](https://github.com/diegosouzapw/OmniRoute) -- 🐛 **Issues**: [report a bug](https://github.com/diegosouzapw/OmniRoute/issues) (attach `npm run system-info` output) -- 🤝 **Contributing**: see [CONTRIBUTING.md](CONTRIBUTING.md), [Branching & Release Model](docs/ops/BRANCHING_MODEL.md), or pick a `good first issue` +| Channel | Where / how | +| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- | +| 💼 **LinkedIn** — follow the maintainer | [linkedin.com/in/diegosouzapw](https://www.linkedin.com/in/diegosouzapw/) | +| 🐙 **GitHub** — follow for releases & tips | [@diegosouzapw](https://github.com/diegosouzapw) | +| 💬 **Discord** | [discord.gg/U47eFqAXCn](https://discord.gg/U47eFqAXCn) | +| ✈️ **Telegram** | [t.me/omnirouteOficial](https://t.me/omnirouteOficial) | +| 🟢 **WhatsApp — 🌍 Global** | [join the group](https://chat.whatsapp.com/JI7cDQ1GyaiDHhVBpLxf8b?mode=gi_t) | +| 🟢 **WhatsApp — 🇧🇷 Brasil** | [entrar no grupo](https://chat.whatsapp.com/LTSpdFhXTxjH4R6CCNiKWz) | +| 🌍 **Website** | [omniroute.online](https://omniroute.online) | +| 📦 **Source code** | [github.com/diegosouzapw/OmniRoute](https://github.com/diegosouzapw/OmniRoute) | +| 🐛 **Report a bug** | [open an issue](https://github.com/diegosouzapw/OmniRoute/issues) — attach `npm run system-info` output | +| 🤝 **Contribute** | [CONTRIBUTING.md](CONTRIBUTING.md) · [Branching & Release Model](docs/ops/BRANCHING_MODEL.md) · pick a `good first issue` | +| ⭐ **Support the project** | [Star the repo](https://github.com/diegosouzapw/OmniRoute) · [GitHub Sponsors](https://github.com/sponsors/diegosouzapw) |