Skip to content

7.4 billion tokens per month. 34 free LLM providers. 635 free model endpoints. All behind one /v1 endpoint, plus any custom OpenAI-compatible endpoint. Smart routing, automatic failover, encrypted keys. Personal experimentation only.

TypeScript

Add Play Store, macOS, Windows, and Docker download badges to the README (#885)

Tashfeen4773ef86a20e
diff --git a/README.md b/README.md
index d549c458..1a75c6c8 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,13 @@ Aggregate free tiers from dozens of providers, plus custom OpenAI-compatible cha
**English** · [简体中文](docs/i18n/zh-CN/README.md)
+<p align="center">
+ <a href="https://play.google.com/store/apps/details?id=co.freellmapi.app"><img src="repo-assets/badges/play-store.svg" height="60" alt="Get it on Google Play"></a>
+ <a href="https://github.com/tashfeenahmed/freellmapi/releases/latest"><img src="repo-assets/badges/macos.svg" height="60" alt="Download for macOS"></a>
+ <a href="https://github.com/tashfeenahmed/freellmapi/releases/latest"><img src="repo-assets/badges/windows.svg" height="60" alt="Download for Windows"></a>
+ <a href="docs/install.md#docker-compose"><img src="repo-assets/badges/docker.svg" height="60" alt="Self-host with Docker"></a>
+</p>
+
![FreeLLMAPI dashboard — Models page with the monthly token budget](repo-assets/github-hero.png)
diff --git a/repo-assets/badges/docker.svg b/repo-assets/badges/docker.svg
new file mode 100644
index 00000000..d4e13fa4
--- /dev/null
+++ b/repo-assets/badges/docker.svg
@@ -0,0 +1,9 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="600" height="180" viewBox="0 0 600 180" role="img" aria-label="Self-Host With Docker">
+ <title>Self-Host With Docker</title>
+ <rect x="3" y="3" width="594" height="174" rx="30" fill="#17171a" stroke="#3a3a42" stroke-width="3"/>
+ <g transform="translate(54,52) scale(3.1667)">
+<path fill="#2496ED" d="M13.983 11.078h2.119a.186.186 0 00.186-.185V9.006a.186.186 0 00-.186-.186h-2.119a.185.185 0 00-.185.185v1.888c0 .102.083.185.185.185m-2.954-5.43h2.118a.186.186 0 00.186-.186V3.574a.186.186 0 00-.186-.185h-2.118a.185.185 0 00-.185.185v1.888c0 .102.082.185.185.185m0 2.716h2.118a.187.187 0 00.186-.186V6.29a.186.186 0 00-.186-.185h-2.118a.185.185 0 00-.185.185v1.887c0 .102.082.185.185.186m-2.93 0h2.12a.186.186 0 00.184-.186V6.29a.185.185 0 00-.185-.185H8.1a.185.185 0 00-.185.185v1.887c0 .102.083.185.185.186m-2.964 0h2.119a.186.186 0 00.185-.186V6.29a.185.185 0 00-.185-.185H5.136a.186.186 0 00-.186.185v1.887c0 .102.084.185.186.186m5.893 2.715h2.118a.186.186 0 00.186-.185V9.006a.186.186 0 00-.186-.186h-2.118a.185.185 0 00-.185.185v1.888c0 .102.082.185.185.185m-2.93 0h2.12a.185.185 0 00.184-.185V9.006a.185.185 0 00-.184-.186h-2.12a.185.185 0 00-.184.185v1.888c0 .102.083.185.185.185m-2.964 0h2.119a.185.185 0 00.185-.185V9.006a.185.185 0 00-.184-.186h-2.12a.186.186 0 00-.186.186v1.887c0 .102.084.185.186.185m-2.92 0h2.12a.185.185 0 00.184-.185V9.006a.185.185 0 00-.184-.186h-2.12a.185.185 0 00-.184.185v1.888c0 .102.082.185.185.185M23.763 9.89c-.065-.051-.672-.51-1.954-.51-.338.001-.676.03-1.01.088-.244-1.687-1.64-2.505-1.703-2.542l-.34-.196-.223.325a4.406 4.406 0 00-.585 1.371c-.222.918-.09 1.781.38 2.52-.566.316-1.475.394-1.66.398H.649a.643.643 0 00-.64.641c-.01 1.171.188 2.335.582 3.438.451 1.182 1.123 2.054 1.998 2.59 1.043.612 2.771 1.023 4.789 1.023 1.006 0 1.995-.088 2.94-.262 1.313-.24 2.575-.7 3.732-1.36a10.116 10.116 0 002.541-2.078c1.213-1.375 1.936-2.907 2.474-4.27h.216c1.37 0 2.212-.548 2.676-1.008.309-.293.55-.65.707-1.046l.098-.288z"/>
+ </g>
+ <text x="172" y="74" font-family="-apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif" font-size="28" font-weight="500" letter-spacing="2.5" fill="#a8a8b3">SELF-HOST WITH</text>
+ <text x="172" y="133" font-family="-apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif" font-size="54" font-weight="700" letter-spacing="-0.5" fill="#ffffff">Docker</text>
+</svg>
diff --git a/repo-assets/badges/macos.svg b/repo-assets/badges/macos.svg
new file mode 100644
index 00000000..ffcd9bab
--- /dev/null
+++ b/repo-assets/badges/macos.svg
@@ -0,0 +1,9 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="600" height="180" viewBox="0 0 600 180" role="img" aria-label="Download For macOS">
+ <title>Download For macOS</title>
+ <rect x="3" y="3" width="594" height="174" rx="30" fill="#17171a" stroke="#3a3a42" stroke-width="3"/>
+ <g transform="translate(54,52) scale(3.1667)">
+<path fill="#ffffff" d="M12.152 6.896c-.948 0-2.415-1.078-3.96-1.04-2.04.027-3.91 1.183-4.961 3.014-2.117 3.675-.546 9.103 1.519 12.09 1.013 1.454 2.208 3.09 3.792 3.039 1.52-.065 2.09-.987 3.935-.987 1.831 0 2.35.987 3.96.948 1.637-.026 2.676-1.48 3.676-2.948 1.156-1.688 1.636-3.325 1.662-3.415-.039-.013-3.182-1.221-3.22-4.857-.026-3.04 2.48-4.494 2.597-4.559-1.429-2.09-3.623-2.324-4.39-2.376-2-.156-3.675 1.09-4.61 1.09zM15.53 3.83c.843-1.012 1.4-2.427 1.245-3.83-1.207.052-2.662.805-3.532 1.818-.78.896-1.454 2.338-1.273 3.714 1.338.104 2.715-.688 3.559-1.701"/>
+ </g>
+ <text x="172" y="74" font-family="-apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif" font-size="28" font-weight="500" letter-spacing="2.5" fill="#a8a8b3">DOWNLOAD FOR</text>
+ <text x="172" y="133" font-family="-apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif" font-size="54" font-weight="700" letter-spacing="-0.5" fill="#ffffff">macOS</text>
+</svg>
diff --git a/repo-assets/badges/play-store.svg b/repo-assets/badges/play-store.svg
new file mode 100644
index 00000000..883ec00e
--- /dev/null
+++ b/repo-assets/badges/play-store.svg
@@ -0,0 +1,12 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="600" height="180" viewBox="0 0 600 180" role="img" aria-label="Get It On Google Play">
+ <title>Get It On Google Play</title>
+ <rect x="3" y="3" width="594" height="174" rx="30" fill="#17171a" stroke="#3a3a42" stroke-width="3"/>
+ <g transform="translate(54,52) scale(3.1667)">
+<path fill="#00D2FF" d="M3.06 2.29a1.5 1.5 0 0 0-.56 1.17v17.08c0 .46.21.88.56 1.17l.09.08L13.8 12.1v-.2L3.15 2.21z"/>
+<path fill="#FFCE00" d="M17.36 15.67l-3.56-3.57v-.2l3.57-3.57.08.05 4.23 2.4c1.21.69 1.21 1.81 0 2.5l-4.23 2.4z"/>
+<path fill="#FF3A44" d="M17.44 15.62L13.8 12 3.06 22.71c.4.42 1.06.47 1.8.05l12.58-7.14"/>
+<path fill="#00F076" d="M17.44 8.38L4.86 1.24c-.74-.42-1.4-.37-1.8.05L13.8 12z"/>
+ </g>
+ <text x="172" y="74" font-family="-apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif" font-size="28" font-weight="500" letter-spacing="2.5" fill="#a8a8b3">GET IT ON</text>
+ <text x="172" y="133" font-family="-apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif" font-size="54" font-weight="700" letter-spacing="-0.5" fill="#ffffff">Google Play</text>
+</svg>
diff --git a/repo-assets/badges/windows.svg b/repo-assets/badges/windows.svg
new file mode 100644
index 00000000..131a35da
--- /dev/null
+++ b/repo-assets/badges/windows.svg
@@ -0,0 +1,9 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="600" height="180" viewBox="0 0 600 180" role="img" aria-label="Download For Windows">
+ <title>Download For Windows</title>
+ <rect x="3" y="3" width="594" height="174" rx="30" fill="#17171a" stroke="#3a3a42" stroke-width="3"/>
+ <g transform="translate(54,52) scale(3.1667)">
+<path fill="#ffffff" d="M0 3.449L9.75 2.1v9.451H0m10.949-9.602L24 0v11.4H10.949M0 12.6h9.75v9.451L0 20.699M10.949 12.6H24V24l-12.9-1.801"/>
+ </g>
+ <text x="172" y="74" font-family="-apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif" font-size="28" font-weight="500" letter-spacing="2.5" fill="#a8a8b3">DOWNLOAD FOR</text>
+ <text x="172" y="133" font-family="-apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif" font-size="54" font-weight="700" letter-spacing="-0.5" fill="#ffffff">Windows</text>
+</svg>