From 1af404c4d90501708338efb6f741ba45c93822be Mon Sep 17 00:00:00 2001 From: tlguszz1010 Date: Tue, 3 Feb 2026 14:08:36 +0900 Subject: [PATCH 1/3] docs: update news date from 2025 to 2026 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 358d23e..f7706d7 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ ## 📢 News -- **2025-02-01** 🎉 nanobot launched! Welcome to try 🐈 nanobot! +- **2026-02-01** 🎉 nanobot launched! Welcome to try 🐈 nanobot! ## Key Features of nanobot: From 73a3934cc59de9a616271f6a121855709635406a Mon Sep 17 00:00:00 2001 From: Re-bin Date: Tue, 3 Feb 2026 07:21:46 +0000 Subject: [PATCH 2/3] docs: unify note/tip format to GitHub Alerts --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 55c6091..cd6fc94 100644 --- a/README.md +++ b/README.md @@ -251,6 +251,9 @@ Config file: `~/.nanobot/config.json` ### Providers +> [!NOTE] +> Groq provides free voice transcription via Whisper. If configured, Telegram voice messages will be automatically transcribed. + | Provider | Purpose | Get API Key | |----------|---------|-------------| | `openrouter` | LLM (recommended, access to all models) | [openrouter.ai](https://openrouter.ai) | @@ -259,7 +262,6 @@ Config file: `~/.nanobot/config.json` | `groq` | LLM + **Voice transcription** (Whisper) | [console.groq.com](https://console.groq.com) | | `gemini` | LLM (Gemini direct) | [aistudio.google.com](https://aistudio.google.com) | -> **Note**: Groq provides free voice transcription via Whisper. If configured, Telegram voice messages will be automatically transcribed.
Full config example @@ -332,6 +334,9 @@ nanobot cron remove ## 🐳 Docker +> [!TIP] +> The `-v ~/.nanobot:/root/.nanobot` flag mounts your local config directory into the container, so your config and workspace persist across container restarts. + Build and run nanobot in a container: ```bash @@ -352,8 +357,6 @@ docker run -v ~/.nanobot:/root/.nanobot --rm nanobot agent -m "Hello!" docker run -v ~/.nanobot:/root/.nanobot --rm nanobot status ``` -> **Tip**: Mount `~/.nanobot` so your config and workspace persist across container restarts. - ## 📁 Project Structure ``` From a4269593fc1e5f11cc94e541bde17cafeadbd248 Mon Sep 17 00:00:00 2001 From: Re-bin Date: Tue, 3 Feb 2026 07:24:59 +0000 Subject: [PATCH 3/3] docs: improve install methods --- README.md | 26 +++++++++----------------- 1 file changed, 9 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index cd6fc94..046860d 100644 --- a/README.md +++ b/README.md @@ -60,19 +60,7 @@ ## 📦 Install -**Install with [uv](https://github.com/astral-sh/uv)** (recommended for speed) - -```bash -uv tool install nanobot-ai -``` - -**Install from PyPi** - -```bash -pip install nanobot-ai -``` - -**Install from source** (recommended for development) +**Install from source** (latest features, recommended for development) ```bash git clone https://github.com/HKUDS/nanobot.git @@ -80,12 +68,16 @@ cd nanobot pip install -e . ``` -**Install with uv** +**Install with [uv](https://github.com/astral-sh/uv)** (stable, fast) ```bash -uv venv -source .venv/bin/activate -uv pip install nanobot-ai +uv tool install nanobot-ai +``` + +**Install from PyPI** (stable) + +```bash +pip install nanobot-ai ``` ## 🚀 Quick Start