Skip to content

[upstream PR 5] docs: rewrite README for v0.3.0 — what, why, and agent support #910

@wbugitlab1

Description

@wbugitlab1

Source repository: rohitg00/agentmemory
Source pull request number: 5
Source URL: intentionally omitted to avoid GitHub cross-references
Title: docs: rewrite README for v0.3.0 — what, why, and agent support
Author: rohitg00
State: closed
Draft: no
Merged: yes
Head: rohitg00/agentmemory:rohit/readme-v0.3.0-rewrite @ 272dddf
Base: main @ dbe421c
Labels: (none)
Changed files: 0
Commits: 0
Created: 2026-02-27T05:11:33Z
Updated: 2026-02-27T05:22:08Z
Closed: 2026-02-27T05:22:06Z
Merged at: 2026-02-27T05:22:06Z

Original PR body:

Summary

  • Rewrites README to clearly explain what agentmemory provides and why someone would choose it over CLAUDE.md or claude-mem
  • Adds Supported Agents section covering native hooks (Claude Code), MCP (Cursor, Windsurf, Cline, etc.), and REST API (any agent/language)
  • Adds decision matrix for choosing the right integration method
  • Documents all v0.3.0 capabilities: hybrid search, 6 embedding providers, memory evolution, project profiles, auto-forget, timeline, export/import
  • Updates all stats to reflect v0.3.0 (21 functions, 10 MCP tools, 28 endpoints, 144 tests, 126KB bundle)

Test plan

  • Verify README renders correctly on GitHub
  • Check all internal anchor links work
  • Confirm stats match actual codebase

Summary by CodeRabbit

  • Documentation
    • Updated README with refreshed introduction highlighting persistent memory capabilities.
    • Reorganized navigation to feature Search, Memory Evolution, and integration methods.
    • Expanded feature documentation including Semantic Search, Auto-forgetting, Privacy, Self-healing, and Observability.
    • Revised Quick Start guides and integration instructions with updated commands.
    • Enhanced API and integration sections with new endpoints and methods.

Local branch:
Fork PR:
Fork decision:
Verification:
Notes:

Metadata

Metadata

Assignees

No one assigned

    Labels

    decision-candidateFork decision has not been madeupstream-mergedUpstream pull request is merged upstreamupstream-prTracks an upstream pull request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions