From 2b77703551094b0781626c06fa6d1d023b098b21 Mon Sep 17 00:00:00 2001 From: Evandro Fonseca Junior Date: Sun, 15 Nov 2026 23:53:46 -0300 Subject: [PATCH] =?UTF-8?q?docs(readme):=20padr=C3=A3o=20SaaS?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 50 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 45de6f9..52ac55a 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ ![React 19](https://img.shields.io/badge/React-19-61DAFB?style=flat-square&logo=react&logoColor=black) ![Platforms](https://img.shields.io/badge/platforms-Windows_%7C_macOS_%7C_Linux-1447e6?style=flat-square) -[Quick start](#quick-start) · [Docs](docs/) · [Issues](https://git.evandro.dev.br/evandro/OllaHub/issues) +**[Get started →](#quick-start)** · [Docs](docs/) · [Issues](https://git.evandro.dev.br/evandro/OllaHub/issues) @@ -26,6 +26,23 @@ OllaHub is a client, not a model runtime. It talks to the Ollama API (default `h **When not to use it:** if you want a finished, tested product (version `0.1.0`, no test suite), a model runtime of its own, or a server you can run without a desktop. +## Features + + + + + + + + + + + + + + +
Hardware-aware setup
Scans your hardware, recommends a model and downloads it on first run.
Streaming chat
History in a local SQLite database with FTS5 full-text search.
Web search
Headless Chrome scrapes Google, Bing, Yahoo, DuckDuckGo and Startpage; local embeddings rank the pages.
Deep research
A mode that runs planning, searching, aggregating, validating and formulating.
MCP tools
MCP servers run as child processes configured in mcp_config.json; the chat can call their tools.
Scheduled tasks
Cron tasks (search and summarize, notification, custom prompt) keep running in the background.
+ ## How it works - **Frontend** (`app/`, `components/`, `hooks/`, `lib/`, `store/`): Next.js 16 with `output: 'export'`, React 19, Tailwind 4, Radix UI and Zustand. It calls the backend through Tauri `invoke` and events. @@ -68,6 +85,36 @@ Early: version `0.1.0`, 47 commits between 2025-10-27 and 2025-11-27, no automat - **Embeddings outside Windows:** the ONNX Runtime library is downloaded automatically only on Windows. On macOS and Linux, provide it in the app data folder or on the system path, otherwise ranking falls back to BM25-like scoring. - **Unused leftovers:** `src-tauri/scripts/scraper.py` is not called by the Rust backend, and the 188 model files in `data/models/` are not referenced by the app code. +## FAQ + +
+Do I need Ollama installed? + +It is needed at runtime. OllaHub tries to start Ollama when it is installed but stopped, and can download the Ollama installer when it is missing. + +
+ +
+Where do my chats live? + +In `ollahub.db` in the app data directory, a local SQLite database with FTS5 full-text search. Besides downloads (models, the embedding model, updates), web search is what reaches the internet. + +
+ +
+Which systems can I build for? + +The release workflow builds `msi` (Windows), `dmg` (macOS, Apple Silicon and Intel) and `AppImage` (Linux). No release is published in this repository yet, so build it locally. + +
+ +
+What is the license? + +No published license: all rights reserved. + +
+ ## License No published license: all rights reserved. @@ -76,6 +123,8 @@ Built with [Tauri](https://tauri.app), [Next.js](https://nextjs.org), [Radix UI]
+Run your models on your desktop. Browse the repository on Gitea or open an issue. + Made by Evandro Fonseca Junior · git.evandro.dev.br