From 515fb86497589c7b92709620dbe93173c2930afd Mon Sep 17 00:00:00 2001
From: Prateek Chhikara <46902268+prateekchhikara@users.noreply.github.com>
Date: Tue, 20 Aug 2024 22:49:44 -0700
Subject: [PATCH] Readme Changes (#1725)

---
 README.md                         | 37 ++++++++++++++++++++++++++++++-
 docs/mint.json                    |  5 ++---
 docs/open-source/graph-memory.mdx |  6 ++---
 3 files changed, 40 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index a7bd4986..25877180 100644
--- a/README.md
+++ b/README.md
@@ -21,9 +21,18 @@
   </a>
 </p>
 
+
 # Introduction
 
-[Mem0](https://mem0.ai) (pronounced "mem-zero") enhances AI assistants and agents with an intelligent memory layer, enabling personalized AI interactions. Mem0 remembers user preferences, adapts to individual needs, and continuously improves over time, making it ideal for customer support chatbots, AI assistants, and autonomous systems.
+[Mem0](https://mem0.ai) (pronounced as "mem-zero") enhances AI assistants and agents with an intelligent memory layer, enabling personalized AI interactions. Mem0 remembers user preferences, adapts to individual needs, and continuously improves over time, making it ideal for customer support chatbots, AI assistants, and autonomous systems.
+
+<!-- Start of Selection -->
+<p style="display: flex;">
+  <img src="https://media.tenor.com/K3j9pwWlME0AAAAi/fire-flame.gif" alt="Graph Memory Integration" style="width: 25px; margin-right: 10px;" />
+  <span style="font-size: 1.2em;">New Feature: Introducing Graph Memory. Check out our <a href="https://docs.mem0.ai/open-source/graph-memory" target="_blank">documentation</a>.</span>
+</p>
+<!-- End of Selection -->
+
 
 ### Core Features
 
@@ -140,6 +149,32 @@ history = m.history(memory_id=<memory_id_1>)
 > [!TIP]
 > If you prefer a hosted version without the need to set up infrastructure yourself, check out the [Mem0 Platform](https://app.mem0.ai/) to get started in minutes.
 
+
+### Graph Memory
+To initialize Graph Memory you'll need to set up your configuration with graph store providers.
+Currently, we support Neo4j as a graph store provider. You can setup [Neo4j](https://neo4j.com/) locally or use the hosted [Neo4j AuraDB](https://neo4j.com/product/auradb/). 
+Moreover, you also need to set the version to `v1.1` (*prior versions are not supported*). 
+Here's how you can do it:
+
+```python
+from mem0 import Memory
+
+config = {
+    "graph_store": {
+        "provider": "neo4j",
+        "config": {
+            "url": "neo4j+s://xxx",
+            "username": "neo4j",
+            "password": "xxx"
+        }
+    },
+    "version": "v1.1"
+}
+
+m = Memory.from_config(config_dict=config)
+
+```
+
 ## Documentation
 
 For detailed usage instructions and API reference, visit our documentation at [docs.mem0.ai](https://docs.mem0.ai). Here, you can find more information on both the open-source version and the hosted [Mem0 Platform](https://app.mem0.ai).
diff --git a/docs/mint.json b/docs/mint.json
index d0d2026f..4852e816 100644
--- a/docs/mint.json
+++ b/docs/mint.json
@@ -61,6 +61,7 @@
       "group": "Open Source",
       "pages": [
         "open-source/quickstart",
+        "open-source/graph-memory",
         {
           "group": "LLMs",
           "pages": [
@@ -117,9 +118,7 @@
         {
           "group": "Features",
           "pages": ["features/openai_compatibility"]
-        },
-        "open-source/graph-memory"
-        
+        }
       ]
     },
     {
diff --git a/docs/open-source/graph-memory.mdx b/docs/open-source/graph-memory.mdx
index 006a1262..a6a9909d 100644
--- a/docs/open-source/graph-memory.mdx
+++ b/docs/open-source/graph-memory.mdx
@@ -8,10 +8,6 @@ With Graph Memory, users can now create and utilize complex relationships betwee
 This integration enables users to leverage the strengths of both vector-based and graph-based approaches, resulting in more accurate and comprehensive information retrieval and generation.
 
 
-> **Note:** The Graph Memory implementation is not standalone. You will be adding/retrieving memories to the vector store and the graph store simultaneously.
-
-
-
 ## Initialize Graph Memory
 
 To initialize Graph Memory you'll need to set up your configuration with graph store providers.
@@ -243,6 +239,8 @@ m.search("Who is spiderman?", user_id="alice123")
 
 ![Graph Memory Visualization](../images/graph_memory/graph_example9.png)
 
+> **Note:** The Graph Memory implementation is not standalone. You will be adding/retrieving memories to the vector store and the graph store simultaneously.
+
 If you want to use a managed version of Mem0, please check out [Mem0](https://app.mem0.ai). If you have any questions, please feel free to reach out to us using one of the following methods:
 
 <Snippet file="get-help.mdx" />
\ No newline at end of file