From f4763a31dafcb101defecb127d32016c24150660 Mon Sep 17 00:00:00 2001 From: jinliyl <6469360+jinliyl@users.noreply.github.com> Date: Sat, 7 Mar 2026 15:54:08 +0800 Subject: [PATCH] docs(readme): update documentation with new features and installation guide (#146) --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ README_ZH.md | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 86 insertions(+) diff --git a/README.md b/README.md index 7bc1ef86..2a85f0ad 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ English Simplified Chinese GitHub Stars + DeepWiki

@@ -33,6 +34,24 @@ conversations) and **stateless sessions** (new sessions cannot inherit history a ReMe gives agents **real memory** — old conversations are automatically compacted, important information is persistently stored, and relevant context is automatically recalled in future interactions. +

+What you can do with ReMe + +
+ +- **Personal assistant**: Provide long-term memory for agents like [CoPaw](https://github.com/agentscope-ai/CoPaw), + remembering user preferences and conversation history. +- **Coding assistant**: Record code style preferences and project context, maintaining a consistent development + experience across sessions. +- **Customer service bot**: Track user issue history and preference settings for personalized service. +- **Task automation**: Learn success/failure patterns from historical tasks to continuously optimize execution + strategies. +- **Knowledge Q&A**: Build a searchable knowledge base with semantic search and exact matching support. +- **Multi-turn dialogue**: Automatically compress long conversations while retaining key information within limited + context windows. + +
+ --- ## 📁 File-based memory system (ReMeLight) @@ -82,7 +101,18 @@ capabilities for AI agents: #### Installation +**Install from source:** + ```bash +git clone https://github.com/agentscope-ai/ReMe.git +cd ReMe +pip install -e ".[light]" +``` + +**Update to the latest version:** + +```bash +git pull pip install -e ".[light]" ``` @@ -546,6 +576,14 @@ For more details on how to reproduce the experiments, see [quickstart.md](benchm - **Acknowledgements**: We thank excellent open-source projects such as OpenClaw, Mem0, MemU, and CoPaw for their inspiration and support. +### Contributors + +Thanks to all who have contributed to ReMe: + + + Contributors + + --- ## 📄 Citation @@ -567,6 +605,14 @@ This project is open-sourced under the Apache License 2.0. See [LICENSE](./LICEN --- +## 🤔 Why ReMe? + +ReMe stands for **Remember Me** and **Refine Me**, symbolizing our goal to help AI agents "remember" users and "refine" +themselves through interactions. We hope ReMe is not just a cold memory module, but a partner that truly helps agents +understand users, accumulate experience, and continuously evolve. + +--- + ## 📈 Star history [![Star History Chart](https://api.star-history.com/svg?repos=agentscope-ai/ReMe&type=Date)](https://www.star-history.com/#agentscope-ai/ReMe&Date) diff --git a/README_ZH.md b/README_ZH.md index bd038f67..1cc60ed4 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -14,6 +14,7 @@ English 简体中文 GitHub Stars + DeepWiki

@@ -30,6 +31,19 @@ ReMe 让智能体拥有**真正的记忆力**——旧对话自动浓缩，重要信息持久保存，下次对话自动想起来。 +

+你可以用 ReMe 做什么 + +
+ +- **个人助理**：为 [CoPaw](https://github.com/agentscope-ai/CoPaw) 等智能体提供长期记忆，记住用户偏好和历史对话。 +- **编程助手**：记录代码风格偏好、项目上下文，跨会话保持一致的开发体验。 +- **客服机器人**：记录用户问题历史、偏好设置，提供个性化服务。 +- **任务自动化**：从历史任务中学习成功/失败模式，持续优化执行策略。 +- **知识问答**：构建可检索的知识库，支持语义搜索和精确匹配。 +- **多轮对话**：自动压缩长对话，在有限上下文窗口内保留关键信息。 + +
--- @@ -78,7 +92,18 @@ working_dir/ #### 安装 +**从源码安装：** + ```bash +git clone https://github.com/agentscope-ai/ReMe.git +cd ReMe +pip install -e ".[light]" +``` + +**更新到最新版本：** + +```bash +git pull pip install -e ".[light]" ``` @@ -527,6 +552,14 @@ Pass@K 衡量在生成 K 个候选中，至少一个成功完成任务（score=1 - **代码贡献**：欢迎任何形式的代码贡献，请参阅 [贡献指南](docs/contribution.md)。 - **致谢**：感谢 OpenClaw、Mem0、MemU、CoPaw 等优秀的开源项目，为项目带来诸多启发与帮助。 +### 贡献者 + +感谢所有为 ReMe 做出贡献的朋友们： + + + 贡献者 + + --- ## 📄 引用 @@ -548,6 +581,13 @@ Pass@K 衡量在生成 K 个候选中，至少一个成功完成任务（score=1 --- +## 🤔 为什么叫 ReMe？ + +ReMe 是 **Remember Me** 和 **Refine Me** 的缩写，寓意让 AI 智能体「记住我」并在交互中「精进自我」。我们希望 ReMe +不只是一个冷冰冰的记忆模块，而是能让智能体真正理解用户、积累经验、持续进化的伙伴。 + +--- + ## 📈 Star 历史 [![Star History Chart](https://api.star-history.com/svg?repos=agentscope-ai/ReMe&type=Date)](https://www.star-history.com/#agentscope-ai/ReMe&Date)