limbo-ai 1.1.0 → 1.3.0

package/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing to Limbo
+
+## Release Process (GHCR)
+
+Stable deploys use pinned semver image tags via `LIMBO_IMAGE_TAG`.
+
+- Release workflow: `.github/workflows/release-ghcr.yml`
+- Published tags per release `vX.Y.Z`:
+  - `ghcr.io/tomasward1/limbo:X.Y.Z`
+  - `ghcr.io/tomasward1/limbo:X`
+  - `ghcr.io/tomasward1/limbo:latest`
+
+### Creating a release
+
+```sh
+git tag -a v1.0.0 -m "Limbo v1.0.0"
+git push origin v1.0.0
+```
+
+### Verifying a public pull
+
+```sh
+docker logout ghcr.io
+docker manifest inspect ghcr.io/tomasward1/limbo:1.0.0
+docker pull ghcr.io/tomasward1/limbo:1.0.0
+```
+
+If GHCR pull is denied (private package or temporary registry policy), the installer falls back to building from source on the target host.
+
+## Branch Strategy
+
+- `main` — production
+- `staging` — integration branch for PRs
+- Never open PRs directly into `main`

package/README.md

@@ -23,7 +23,7 @@ This will:
 2. Write `~/.limbo/.env` and `~/.limbo/docker-compose.yml`
 3. Pull the latest Limbo image and start the container
 
-Limbo binds to `127.0.0.1:18789`. Connect via the OpenClaw gateway or Telegram bot.
+Limbo binds to `127.0.0.1:18789`.
 
 ### Available commands
 
@@ -40,43 +40,21 @@ npx limbo-ai start --reconfigure   # Change API keys or settings
 
 ## Updating
 
-To pull the latest Limbo image and restart:
-
 ```sh
 npx limbo-ai update
 ```
 
-This runs `docker compose pull` followed by `docker compose up -d` in `~/.limbo`. Your vault data is persisted in the `limbo-data` Docker volume and is not affected by updates.
+Pulls the latest Limbo image and restarts the container. Your vault data is persisted in the `limbo-data` Docker volume and is not affected.
 
 ---
 
-## Agent Instructions
-
-Limbo exposes an MCP server on the running container. To connect an AI agent (Claude Code, Claude Desktop, or any OpenClaw-compatible client) to your Limbo instance, point it at the WebSocket gateway:
-
-```
-ws://localhost:18789
-```
-
-### Claude Code (MCP config)
-
-Add to your project's `.claude/mcp.json` or `~/.claude/mcp.json`:
-
-```json
-{
-  "mcpServers": {
-    "limbo": {
-      "url": "ws://localhost:18789"
-    }
-  }
-}
-```
+## Connecting
 
-### OpenClaw (direct)
+The easiest way to talk to Limbo is via **Telegram** — set up once, works from any device.
 
-Point any OpenClaw-compatible client at `ws://localhost:18789`.
+For everything else, Limbo speaks over WebSocket at `ws://localhost:18789` via the OpenClaw gateway. Any OpenClaw-compatible client can connect there directly.
 
-### Telegram
+### Telegram (recommended)
 
 Set `TELEGRAM_ENABLED=true` and `TELEGRAM_BOT_TOKEN` in `~/.limbo/.env`, then restart:
 
@@ -84,31 +62,26 @@ Set `TELEGRAM_ENABLED=true` and `TELEGRAM_BOT_TOKEN` in `~/.limbo/.env`, then re
 npx limbo-ai start --reconfigure
 ```
 
----
-
-## Release Channel (GHCR)
-
-Stable deploys should use a pinned semver image tag via `LIMBO_IMAGE_TAG`.
+Message your bot and Limbo will respond.
 
-- Release workflow source: `.github/workflows/release-ghcr.yml`
-- Published tags per release tag `vX.Y.Z`:
-  - `ghcr.io/tomasward1/limbo:X.Y.Z`
-  - `ghcr.io/tomasward1/limbo:X`
-  - `ghcr.io/tomasward1/limbo:latest`
+### Without Telegram
 
-Create a release tag:
+Connect any [OpenClaw](https://openclaw.dev)-compatible client to:
 
-```sh
-git tag -a v1.0.0 -m "Limbo v1.0.0"
-git push origin v1.0.0
+```
+ws://localhost:18789
 ```
 
-Verify public pull (no credentials):
+This includes Claude Code — add Limbo to your MCP config:
 
-```sh
-docker logout ghcr.io
-docker manifest inspect ghcr.io/tomasward1/limbo:1.0.0
-docker pull ghcr.io/tomasward1/limbo:1.0.0
+```json
+{
+  "mcpServers": {
+    "limbo": {
+      "url": "ws://localhost:18789"
+    }
+  }
+}
 ```
 
 ---
@@ -153,12 +126,13 @@ Full tool specs in `workspace/TOOLS.md`.
 │              Docker Container           │
 │                                         │
 │  ┌─────────────┐    ┌────────────────┐  │
-│  │  OpenClaw   │◄──►│  Claude (LLM)  │  │
-│  │  Gateway    │    └────────┬───────┘  │
-│  │  :18789     │             │          │
-│  └──────┬──────┘    ┌────────▼───────┐  │
-│         │           │  MCP Server    │  │
-│  Telegram Bot        │  limbo-vault  │  │
+│  │  OpenClaw   │◄──►│  LLM (Claude   │  │
+│  │  Gateway    │    │  or OpenAI)    │  │
+│  │  :18789     │    └────────┬───────┘  │
+│  └──────┬──────┘             │          │
+│         │           ┌────────▼───────┐  │
+│  Telegram Bot        │  MCP Server   │  │
+│         │           │  limbo-vault  │  │
 │         │           └────────┬───────┘  │
 │         └────────────────────┤          │
 │                              ▼          │
@@ -167,7 +141,7 @@ Full tool specs in `workspace/TOOLS.md`.
 └─────────────────────────────────────────┘
 ```
 
-- **OpenClaw** — gateway that wraps the Claude API with MCP tool support and optional Telegram integration
+- **OpenClaw** — gateway that handles client connections, routes to the LLM, and integrates MCP tools
 - **MCP server** — Node.js server providing vault read/write tools
 - **Vault** — plain markdown files with YAML frontmatter, persisted in a named Docker volume
 - **Migrations** — lightweight Node.js migration runner for vault schema changes
@@ -214,3 +188,7 @@ docker run --rm -e LLM_API_KEY=sk-ant-... -p 18789:18789 limbo:dev
 ```sh
 node migrations/index.js
 ```
+
+---
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for release and deployment process.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "limbo-ai",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "Your personal AI memory agent — install and manage Limbo via npx",
   "type": "commonjs",
   "bin": {