Skip to content

docs: rewrite README around three usage scenarios + add bilingual README_ZH - #2078

Merged
syzsunshine219 merged 8 commits into
MemTensor:dev-v2.0.23from
shinetata:docs/readme-rewrite
Jul 9, 2026
Merged

syzsunshine219 merged 8 commits into
MemTensor:dev-v2.0.23from
shinetata:docs/readme-rewrite

Conversation

@shinetata

Copy link
Copy Markdown
Collaborator

Summary

  • Rewrite README.md around three entry points (Self-Host / OpenClaw Cloud Plugin / Local Plugin) and add a full Chinese README_ZH.md, kept structurally in sync.
  • Restore the visual layout: centered linked logo, shield badges (Docs / ArXiv / Follow / Discord / Resources), top plugin banner, and the WeChat QR code.
  • Add a "MemOS: Memory Operating System" overview (Key Features + News), a Performance table, and a "What MemOS Is For" section.
  • Add local-plugin install commands for macOS/Linux and Windows (robust download-then-run form, not irm|iex) with a prerequisites note (Node.js + an installed OpenClaw/Hermes).

Scope

  • Only README.md and README_ZH.md are changed. Merges cleanly into dev-v2.0.23 (no README changes on that branch since the v2.0.22 branch point; README_ZH.md is new).

Test plan

  • Render README.md and README_ZH.md on GitHub; confirm logo, badges, banner, and QR image all display.
  • Verify English | 中文 links switch between the two files, with the current language bolded.
  • Confirm EN/ZH section order and content match.

Made with Cursor

sunqi and others added 6 commits July 9, 2026 00:26
- Rewrite README.md around three entry points: self-host, OpenClaw cloud plugin, local plugin
- Add Performance block with 10 benchmark scores from 2026-07-02 evaluation report
- Add "What MemOS Is For" section and decision table for scenario navigation
- Add Chinese README_ZH.md with bidirectional language switch links
- Use official slogan "Intelligence begins with memory" as tagline

Co-authored-by: Cursor <cursoragent@cursor.com>
- Restore top banner GIF, logo, title, shield badges from original README
- Replace performance highlights list with official slogan
- Add Performance block with 10 benchmark scores
- Restructure Quick Start: Self-Host and Plugin as peer ### sections,
  Cloud Plugin and Local Plugin as #### subsections under Plugin
- Remove redundant Docker note from Local Plugin section
- Sync structure between English and Chinese versions

Co-authored-by: Cursor <cursoragent@cursor.com>
…tions

- Restore centered logo (with link to memos.openmem.net), title, and shield
  badges (Docs, ArXiv, Follow, Discord, Resources) in both READMEs
- Restore plugin banner image under the MemOS Plugin section header
- Restore WeChat QR code under the Community section
- Sync structure between English and Chinese versions
- Add macOS/Linux and Windows install commands for memos-local-plugin,
  with a prerequisites note (Node.js + an installed OpenClaw/Hermes)
- Use robust download-then-run form on Windows instead of irm|iex so
  errors stay visible and the script dir resolves correctly
- Add "MemOS: Memory Operating System" overview section (Key Features + News)
- Move plugin banner to the top; simplify the tagline
- Keep English and Chinese versions structurally in sync

Co-authored-by: Cursor <cursoragent@cursor.com>
Bring the Chinese README visually in sync with the English version:
centered logo (linked), shield badges, top plugin banner, and the
WeChat QR code in the Community section.

Co-authored-by: Cursor <cursoragent@cursor.com>
@CarltonXiang
CarltonXiang changed the base branch from dev-v2.0.23 to main July 9, 2026 03:28
@CarltonXiang
CarltonXiang changed the base branch from main to dev-v2.0.23 July 9, 2026 03:29
@Memtensor-AI Memtensor-AI added the area:docs 文档、示例 label Jul 9, 2026
sunqi and others added 2 commits July 9, 2026 13:44
Add the managed MemOS Cloud API as a fourth entry point in the Quick
Start of both README.md and README_ZH.md: a comparison-table column,
API-key setup, an add/search code example, and next-step doc links.
Mirrors the Cloud API section from upstream main.

Co-authored-by: Cursor <cursoragent@cursor.com>
@syzsunshine219
syzsunshine219 merged commit 40f8e83 into MemTensor:dev-v2.0.23 Jul 9, 2026
16 checks passed
Memtensor-AI pushed a commit to Memtensor-AI/MemOS that referenced this pull request Jul 9, 2026
…mance table

The News section for 2026-07-02 quoted LoCoMo=92.34 and LongMemEval=93.40
(added in MemTensor#2019), while the Performance table just below reports 88.83 and
89.20 (added in MemTensor#2078 with the 10-benchmark 2026-07-02 evaluation report).
Update the News entry in both README.md and README_ZH.md to 88.83 / 89.20 so
the two sections agree; the Performance table remains the authoritative
source.

Closes MemTensor#2090
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs 文档、示例

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants