From 0cb201cd53e92d07854f9f59da97d57e09e95ddd Mon Sep 17 00:00:00 2001
From: Daniel Chalef <131175+danielchalef@users.noreply.github.com>
Date: Tue, 27 Aug 2024 11:02:30 -0700
Subject: [PATCH] Update README.md w/ spacing
---
README.md | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/README.md b/README.md
index 964c7eb..53c5d48 100644
--- a/README.md
+++ b/README.md
@@ -34,6 +34,8 @@ With graphiti, you can build LLM applications such as:
graphiti supports a wide range of applications in sales, customer service, health, finance, and more, enabling long-term recall and state-based reasoning for both assistants and agents.
+
+
## Why graphiti?
graphiti is designed for dynamic data and agentic use:
@@ -45,12 +47,16 @@ graphiti is designed for dynamic data and agentic use:
- **Fast**: Search results in < 100ms, with latency primarily determined by the 3rd-party embedding API call.
- **Schema Consistency**: Maintains a coherent graph structure by reusing existing schema, preventing unnecessary proliferation of node and edge types.
+
+
## graphiti and Zep Memory
graphiti powers the core of Zep's next-generation memory layer for LLM-powered Assistants and Agents.
We're excited to open-source graphiti, believing its potential reaches far beyond memory applications.
+
+
## Installation
Requirements:
@@ -72,6 +78,8 @@ or
`poetry add graphiti-core`
+
+
## Quick Start
> [!IMPORTANT]
@@ -136,6 +144,8 @@ await client.search('Who was the California Attorney General?', center_node_uuid
graphiti.close()
```
+
+
## Documentation
### Adding Episodes
@@ -340,6 +350,8 @@ print_facts(results)
> The Allbirds Wool Runners are sold by Allbirds.
```
+
+
## Status and Roadmap
graphiti is under active development. We aim to maintain API stability while working on:
@@ -354,6 +366,7 @@ graphiti is under active development. We aim to maintain API stability while wor
- [ ] Enhancing retrieval capabilities with more robust and configurable options
- [ ] Expanding test coverage to ensure reliability and catch edge cases
+
## Contributing