From 3086894704778206b03077344505e18de1eeb04b Mon Sep 17 00:00:00 2001 From: Diego Rodrigues de Sa e Souza <8016841+diegosouzapw@users.noreply.github.com> Date: Sat, 6 Jun 2026 04:24:46 -0300 Subject: [PATCH] docs(readme): consolidate community at top (Discord + Telegram + WhatsApp) + promote Free-Token Budget section (#3289) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add the official Telegram group (t.me/omnirouteOficial) and gather Discord, Telegram and both WhatsApp groups into one community card block at the top; remove the scattered WhatsApp links from the nav line and the Support section (now a pointer to the top). - Move the Free-Token Budget section from the bottom (before License) up to a hero section near the top, retitled 'πŸ’° ~1.9B Free Tokens / Month'. --- README.md | 48 ++++++++++++++++++++++++++---------------------- 1 file changed, 26 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index e3e814d6b9..e56197c887 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,14 @@
-### πŸ’¬ Join the community on Discord +### πŸ’¬ Join the community -[![Join our Discord](https://img.shields.io/badge/Join_our_Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/hmexnhgE) +[![Discord](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/hmexnhgE) +[![Telegram](https://img.shields.io/badge/Telegram-26A5E4?style=for-the-badge&logo=telegram&logoColor=white)](https://t.me/omnirouteOficial) +[![WhatsApp Global](https://img.shields.io/badge/WhatsApp_Global-25D366?style=for-the-badge&logo=whatsapp&logoColor=white)](https://chat.whatsapp.com/JI7cDQ1GyaiDHhVBpLxf8b?mode=gi_t) +[![WhatsApp Brasil](https://img.shields.io/badge/WhatsApp_Brasil-25D366?style=for-the-badge&logo=whatsapp&logoColor=white)](https://chat.whatsapp.com/CeGCxdFzqBe5Uki288wOvf) -**Questions, provider tips, roadmap & support β†’ [discord.gg/hmexnhgE](https://discord.gg/hmexnhgE)** +**Questions, provider tips, roadmap & support β†’ [Discord](https://discord.gg/hmexnhgE) Β· [Telegram](https://t.me/omnirouteOficial) Β· WhatsApp [🌍 Global](https://chat.whatsapp.com/JI7cDQ1GyaiDHhVBpLxf8b?mode=gi_t) / [πŸ‡§πŸ‡· Brasil](https://chat.whatsapp.com/CeGCxdFzqBe5Uki288wOvf)**
@@ -56,7 +59,7 @@
-[**πŸš€ Quick Start**](#-quick-start) β€’ [**🎯 Combos**](#-combos--the-flagship) β€’ [**🌐 Providers**](#-177-ai-providers--50-free) β€’ [**πŸ”Œ CLI & MCP**](#-full-cli--a2a--mcp) β€’ [**πŸ—œοΈ Compression**](#%EF%B8%8F-save-1595-tokens--automatically) β€’ [**🌍 Website**](https://omniroute.online) β€’ [**πŸ’¬ WhatsApp 🌍**](https://chat.whatsapp.com/JI7cDQ1GyaiDHhVBpLxf8b?mode=gi_t) β€’ [**πŸ’¬ WhatsApp πŸ‡§πŸ‡·**](https://chat.whatsapp.com/CeGCxdFzqBe5Uki288wOvf) +[**πŸš€ Quick Start**](#-quick-start) β€’ [**🎯 Combos**](#-combos--the-flagship) β€’ [**🌐 Providers**](#-177-ai-providers--50-free) β€’ [**πŸ”Œ CLI & MCP**](#-full-cli--a2a--mcp) β€’ [**πŸ—œοΈ Compression**](#%EF%B8%8F-save-1595-tokens--automatically) β€’ [**🌍 Website**](https://omniroute.online) [πŸ’₯ The Promise](#-the-promise) β€’ [πŸ€” Why](#-why-omniroute) β€’ [πŸ† What Sets Apart](#-what-sets-omniroute-apart) β€’ [πŸ€– Compatible CLIs](#-compatible-clis--coding-agents) β€’ [πŸ–₯️ Where It Runs](#%EF%B8%8F-where-omniroute-runs--anywhere) β€’ [πŸ”’ Private](#-private--local-first) β€’ [🎬 In Action](#-omniroute-in-action) β€’ [πŸ“š Explore More](#-explore-more) β€’ [πŸ“§ Support](#-support--community) @@ -111,6 +114,24 @@
+# πŸ’° ~1.9B Free Tokens / Month + +
+ +> 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 **50+ provider pools / 530 models** into one honest number and shows it live on the dashboard (`/dashboard/free-tiers`). + +- **~1.9B free tokens / month** (steady) β€” and **up to ~2.5B in your first month** with signup credits. +- **Pool-deduped, honest** β€” we count each shared free pool **once**, so the headline isn't inflated by rate-limit ceilings the way multi-billion competitor claims are. (The naΓ―ve per-model sum would read ~8B; we don't publish that.) +- **Per-model breakdown**, **live used / remaining** for the current month, and a transparent **terms flag** per provider. + +![Free-Tier Budget card (preview mockup)](docs/screenshots/free-tier-budget-card.svg) + +> Preview mockup β€” a real screenshot lands once the `/dashboard/free-tiers` page is validated. Full methodology (pool dedupe, credit tiers, provider terms): **[docs/reference/FREE_TIERS.md](docs/reference/FREE_TIERS.md)**. + +
+ +
+ # πŸ’₯ The Promise
@@ -743,8 +764,7 @@ Compression: aggressive (~50%) β†’ double your free quota Β· Cost: $0/mo # πŸ“§ Support & Community -> πŸ’¬ **Join our WhatsApp groups** β€” get help, share tips, stay updated: -> Β· [**🌍 International**](https://chat.whatsapp.com/JI7cDQ1GyaiDHhVBpLxf8b?mode=gi_t) Β· [**πŸ‡§πŸ‡· PortuguΓͺs**](https://chat.whatsapp.com/CeGCxdFzqBe5Uki288wOvf) +> πŸ’¬ **Chat with the community** β€” Discord, Telegram & WhatsApp (🌍 / πŸ‡§πŸ‡·) links are at the [top of this README](#-join-the-community). - 🌍 **Website**: [omniroute.online](https://omniroute.online) - πŸ™ **GitHub**: [github.com/diegosouzapw/OmniRoute](https://github.com/diegosouzapw/OmniRoute) @@ -980,22 +1000,6 @@ Special thanks to **[RTK - Rust Token Killer](https://github.com/rtk-ai/rtk)** b Special thanks to **[Troglodita](https://github.com/leninejunior/troglodita)** by **[Lenine JΓΊnior](https://github.com/leninejunior)** β€” the PT-BR token compression project ("por que gastar muitos tokens quando poucos resolve?") whose Portuguese-native rules power OmniRoute's pt-BR language pack: pleonasm reduction, filler removal tuned for Brazilian Portuguese grammar, and technical abbreviations for the dev BR community. -
- -## πŸ’° Free-Token Budget β€” see exactly how much free inference you have - -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 **50+ provider pools / 530 models** into one honest number and shows it live on the dashboard (`/dashboard/free-tiers`). - -- **~1.9B free tokens / month** (steady) β€” and **up to ~2.5B in your first month** with signup credits. -- **Pool-deduped, honest:** we count each shared free pool **once**, so the headline isn't inflated by rate-limit ceilings the way multi-billion competitor claims are. (The naΓ―ve per-model sum would read ~8B; we don't publish that.) -- **Per-model breakdown**, **live used / remaining** for the current month, and a **ToS flag** for the 19 providers whose terms don't permit proxying. - -![Free-Tier Budget card (preview mockup)](docs/screenshots/free-tier-budget-card.svg) - -> Preview mockup β€” a real screenshot lands once the `/dashboard/free-tiers` page is validated. Full methodology (pool dedupe, credit tiers, the 19 ToS-restricted providers): **[docs/reference/FREE_TIERS.md](docs/reference/FREE_TIERS.md)**. - -
- ## πŸ“„ License MIT License - see [LICENSE](LICENSE) for details.