From 19e4adbb2e65b5e269b3a99f4d9282e1c06ad609 Mon Sep 17 00:00:00 2001 From: matevip Date: Sun, 19 Apr 2026 21:14:57 +0800 Subject: [PATCH] docs(readme): rewrite both READMEs around 1.1.x product features MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Hero + headline - Lead with the insight most AI tools fail on: vendors go down, memory resets, one channel = one product. Position MateClaw as the whole widget — one deployment covering reasoning, knowledge, memory, tools and channels. Three product anchors replace the old feature wall 1. Multi-model failover — primary vendor key fails, runtime routes to the next healthy provider (DashScope / OpenAI / Anthropic / Gemini / DeepSeek / Kimi / Ollama / LM Studio / MLX, 14+ total) with a provider health tracker cooling down bad vendors. 2. Knowledge that links itself — LLM Wiki digests raw material into linked pages with citation-level traceability. 3. Five surfaces, one brain — Web Console, Desktop (bundled JRE 21), Webchat Widget, 7 IM channels, Plugin SDK. Comparison table tightened - 13-column × 7-product matrix collapsed to 5 rows × 4 competitors, focused on dimensions where MateClaw carves real space. Project structure corrected - Previous version only listed 3 modules. Now lists all seven: mateclaw-server / -ui / -desktop / -webchat / -plugin-api / -plugin-sample / matevip-sites. Tech stack updated - Java badge bumped to 21+ (was 17+); Flyway surfaced; Webchat row added. Size: each README 230 → 203 lines. --- README.md | 235 ++++++++++++++++++++++-------------------------- README_zh.md | 247 +++++++++++++++++++++++---------------------------- 2 files changed, 214 insertions(+), 268 deletions(-) diff --git a/README.md b/README.md index 9a157378..baebca64 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,13 @@ # MateClaw -

Build AI that thinks, acts, remembers, and ships.

+

AI that thinks, acts, remembers — and keeps going when one model dies.

[![GitHub Repo](https://img.shields.io/badge/GitHub-Repo-black.svg?logo=github)](https://github.com/matevip/mateclaw) [![Documentation](https://img.shields.io/badge/Docs-Website-green.svg?logo=readthedocs&label=Docs)](https://claw.mate.vip/docs) [![Live Demo](https://img.shields.io/badge/Demo-Online-orange.svg?logo=vercel&label=Demo)](https://claw-demo.mate.vip) [![Website](https://img.shields.io/badge/Website-claw.mate.vip-blue.svg?logo=googlechrome&label=Site)](https://claw.mate.vip) -[![Java Version](https://img.shields.io/badge/Java-17+-blue.svg?logo=openjdk&label=Java)](https://adoptium.net/) +[![Java Version](https://img.shields.io/badge/Java-21+-blue.svg?logo=openjdk&label=Java)](https://adoptium.net/) [![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.5-brightgreen.svg?logo=springboot)](https://spring.io/projects/spring-boot) [![Vue](https://img.shields.io/badge/Vue-3-4FC08D.svg?logo=vuedotjs)](https://vuejs.org/) [![Last Commit](https://img.shields.io/github/last-commit/matevip/mateclaw)](https://github.com/matevip/mateclaw) @@ -28,123 +28,89 @@ --- -An AI agent. A knowledge engine. A memory system. A tool runtime. A multi-channel presence. +Most AI tools forget you the moment the tab closes. Most fall over when their model vendor has a bad day. Most give you a chatbox and call it a product. -**One product. The whole widget.** +**MateClaw is the whole widget.** One deployment. Reasoning, knowledge, memory, tools, and multi-channel presence — built together, not bolted on. -MateClaw is a personal AI operating system built with **Java + Vue 3**, powered by [Spring AI Alibaba](https://github.com/alibaba/spring-ai-alibaba). It's not a chatbox, not a workflow builder, not just another coding assistant. It's the entire system — from reasoning to remembering to shipping — in one deployment. +--- -Three things make it insanely different: +## Three things that make it different -1. **Agents do work, not just talk** — ReAct + Plan-and-Execute. Not one-shot answers — iterative reasoning that actually completes tasks -2. **Knowledge is shaped, not just stored** — An LLM Wiki that digests raw material into structured, linked pages. The difference between a warehouse and a library -3. **End-to-end, no compromises** — Web console, desktop app, 7 IM channels, tool guardrails, enterprise auth. One team, one deployment, one experience +### 1 · Your AI doesn't die when a model does + +Primary key expired. Vendor returns 401. Network blip. Quota drained. + +Other tools hand you a red error card. MateClaw routes to the next healthy provider — DashScope, OpenAI, Anthropic, Gemini, DeepSeek, Kimi, Ollama, LM Studio, MLX, 14+ in total — and the user sees the reply finish. A provider health tracker parks bad vendors in a cooldown window so they don't waste seconds on every turn. + +You don't configure a retry script. You set priorities in the web UI. The runtime does the rest. + +### 2 · Knowledge that links itself + +Upload a PDF, a batch of markdown, a scraped page — raw material in. + +MateClaw's **LLM Wiki** digests it into structured pages, builds `[[links]]` between them, and remembers where every sentence came from. Click a citation, see the exact source chunk. Ask a question, the page you get is stitched from the right chunks — with references you can verify. + +This is the difference between a warehouse and a library. + +### 3 · One product, five surfaces + +| Surface | What it is | +|---|---| +| **Web Console** | Full admin — agents, models, tools, skills, knowledge, security, cron | +| **Desktop** | Electron app with a bundled JRE 21. Double-click, run. No Java install | +| **Webchat Widget** | One `